Seu pagamento foi aprovado. Referente ao Pedido #1305371685465-01 |
| Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto. |
Pagamento Visa final 1111 R$ 3,99 à vista |
| Atenciosamente, |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).",
"operationId": "RegisterChange",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "Type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "orderId",
"in": "path",
"description": "ID that identifies the order in the seller.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "1172452900788-01"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"requestId",
"reason",
"discountValue",
"incrementValue"
],
"properties": {
"requestId": {
"type": "string",
"description": "Request identification of the change. Only the first change made with each `requestId` will be effective on a given order. Use different IDs for different changes to the same order.",
"example": "change-request-0123"
},
"reason": {
"type": "string",
"description": "Reason for order change. This may be shown to the shopper in the UI or transactional emails.",
"example": "Stock shortage"
},
"discountValue": {
"type": "integer",
"description": "This field can be used to apply a discount to the total value of the order. Value in cents.",
"example": 100
},
"incrementValue": {
"type": "integer",
"description": "This field can be used to increment the total value of the order. Value in cents.",
"example": 100
},
"itemsRemoved": {
"type": "array",
"description": "List of items that should be removed from the order.",
"items": {
"type": "object",
"description": "Removed items' details.",
"required": [
"id",
"price",
"quantity"
],
"properties": {
"id": {
"type": "string",
"description": "Product ID of the item.",
"example": "0"
},
"price": {
"type": "integer",
"description": "Price of the item in cents.",
"example": 2499
},
"quantity": {
"type": "integer",
"description": "Amount of items to be removed.",
"example": 1
}
}
}
},
"itemsAdded": {
"type": "array",
"description": "List of items that should be added to the order.",
"items": {
"type": "object",
"description": "Added items' details.",
"required": [
"id",
"price",
"quantity"
],
"properties": {
"id": {
"type": "string",
"description": "Product ID of the item.",
"example": "0"
},
"price": {
"type": "integer",
"description": "Price of the item in cents.",
"example": 2499
},
"quantity": {
"type": "integer",
"description": "Amount of items to be added.",
"example": 1
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Date of order change."
},
"orderId": {
"type": "string",
"description": "ID of the order."
},
"receipt": {
"type": "string",
"description": "Receipt identification."
}
}
},
"example": {
"date": "2024-02-08T13:54:33.6868469+00:00",
"orderId": "v502538llux-01",
"receipt": "535d4581-a2a2-4fd2-a206-1c61eae91b1e"
}
}
}
}
}
}
},
"/api/oms/pvt/orders/{orderId}/interactions": {
"post": {
"tags": ["Orders"],
"summary": "Add log in orders",
"description": "Add a Log in Interactions Order Array.",
"operationId": "AddLog",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "Type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "orderId",
"in": "path",
"description": "Unique code that identifies an order.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "1172452900788-01"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"source",
"message"
],
"properties": {
"source": {
"type": "string",
"description": "Source information.",
"example": "Postman"
},
"message": {
"type": "string",
"description": "Interactions message.",
"example": "Add interactions"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/oms/pvt/orders/{orderId}/invoice": {
"post": {
"tags": ["Invoice"],
"summary": "Order invoice notification",
"description": "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to the `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \r\n\r\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \r\n\r\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \r\n\r\n## Partial invoices \r\n\r\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \r\n\r\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \r\n\r\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \r\n\r\n## Returning items \r\n\r\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \r\n\r\n- `output`: selling order invoice. \r\n\r\n- `input`: returning items invoice. \r\n\r\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \r\n\r\n## Changing the receipt code \r\n\r\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\r\n\r\n## Integration with marketplaces \r\n\r\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \r\n\r\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Notify invoice** |\r\n| OMS | OMS access | **Notify refund** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
"operationId": "InvoiceNotification",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "orderId",
"in": "path",
"description": "Unique code that identifies the order whose invoice is being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "1172452900788-01"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"type",
"issuanceDate",
"invoiceNumber",
"invoiceValue",
"items"
],
"properties": {
"type": {
"type": "string",
"description": "The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.",
"example": "Output"
},
"issuanceDate": {
"type": "string",
"description": "The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field.",
"example": "2024-01-31T18:25:43-05:00"
},
"invoiceNumber": {
"type": "string",
"description": "Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code.",
"example": "DFG-v7731485plzv-01",
"nullable": true
},
"invoiceValue": {
"type": "string",
"description": "Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.",
"example": "2499"
},
"invoiceKey": {
"type": "string",
"nullable": true,
"description": "Information about invoice key.",
"example": "CFe35201100063960001504590006629690333214542150"
},
"invoiceUrl": {
"type": "string",
"description": "URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations.",
"nullable": true,
"example": "https://luxstore.com/invoices/24382.pdf"
},
"embeddedInvoice": {
"type": "string",
"nullable": true,
"description": "XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre.",
"example": "
|
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order you wish to change.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createchange" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response202" }, "example": { "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", "reason": "The client did not like the size.", "manualDiscountValue": 0, "manualIncrementValue": 0, "totalChangeValue": 0, "totals": [], "add": null, "remove": null, "replace": [ { "from": { "paymentData": { "transactions": [] }, "items": [ { "id": "31", "quantity": 1, "price": null, "measurementUnit": null, "unitMultiplier": 0, "sellingPrice": null, "name": null, "detailUrl": null, "imageUrl": null } ], "shippingData": { "logisticsInfo": [] } }, "to": { "items": [ { "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", "id": "1", "productId": null, "productRefId": null, "refId": null, "ean": null, "name": null, "skuName": null, "modalType": null, "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": null, "tax": 0, "price": null, "listPrice": null, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": null, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": null, "brandId": null, "offeringInfo": null, "offeringType": null, "offeringTypeId": null, "categoriesIds": null, "productClusterId": null, "commercialConditionId": null }, "preSaleDate": null, "productCategoryIds": null, "productCategories": {}, "quantity": 1, "seller": null, "sellerChain": [ null ], "imageUrl": null, "detailUrl": null, "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": null, "measurementUnit": "un", "unitMultiplier": 1, "manufacturerCode": null, "priceDefinition": null } ], "paymentData": { "transactions": [] }, "receiptData": null, "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Lenta", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Lenta", "deliveryChannel": "delivery", "name": "Lenta", "deliveryIds": [], "shippingEstimate": null, "shippingEstimateDate": null, "lockTTL": null, "availableDeliveryWindows": [], "deliveryWindow": null, "price": 600, "listPrice": 600, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": null, "transitTime": null } ], "shipsTo": [], "itemId": "1", "deliveryChannels": [], "price": 600, "listPrice": 600, "shippingEstimate": null, "dockEstimate": null, "shippingEstimateDate": null, "lockTTL": null, "deliveryCompany": null, "polygonName": null, "transitTime": null, "sellingPrice": 600, "deliveryIds": [], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } } } ], "date": "2023-07-27T17:52:18.6483116Z", "origin": { "account": "qastore", "orderId": "v12772213qst-02", "component": "MarketplaceComponent" }, "settings": { "customPaymentSystemsAllowed": [ "201" ] } } } } } } }, "get": { "tags": [ "Change order (beta)" ], "summary": "Get order change history", "operationId": "GetChangeHistory", "description": "This endpoint retrieves a history of every successful [Change order request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single change request, you can use the endpoint [Get order change details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:/developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order you wish to get the change history.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "requests", "actions" ], "properties": { "requests": { "type": "array", "description": "Array with change order requests details.", "items": { "required": [ "requestId", "workflowId", "reason", "manualDiscountValue", "manualIncrementValue", "totalChangeValue", "totals", "add", "remove", "replace", "date", "origin", "settings" ], "type": "object", "description": "Information about each change order request.", "properties": { "requestId": { "type": "string", "description": "Unique code that identifies an order change." }, "workflowId": { "type": "string", "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." }, "reason": { "type": "string", "description": "Reason that motivated the order change." }, "manualDiscountValue": { "type": "integer", "description": "This field shows if it was applied a manual price for the total order amount. The value is in cents." }, "manualIncrementValue": { "type": "integer", "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." }, "totalChangeValue": { "type": "integer", "description": "This field shows how much the order total price is, considering that price changes might have been made. The value is in cents." }, "totals": { "type": "array", "description": "Array containing total costs information.", "items": { "type": "object", "description": "Total changing price details for a given type of cost.", "properties": { "id": { "type": "string", "description": "Changing price type, for example the item price or shipping costs." }, "name": { "type": "string", "description": "Changing price name." }, "value": { "type": "number", "description": "Changing price value in cents." } } } }, "add": { "type": "object", "nullable": true, "description": "Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`." }, "remove": { "type": "object", "nullable": true, "description": "Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`." }, "replace": { "type": "array", "description": "Array with information about the replacement operation performed.", "items": { "type": "object", "description": "Replacing operation object.", "required": [ "from", "to" ], "properties": { "from": { "$ref": "#/components/schemas/From2" }, "to": { "$ref": "#/components/schemas/To2" } } } }, "date": { "type": "string", "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`." }, "origin": { "$ref": "#/components/schemas/OriginV2" }, "settings": { "$ref": "#/components/schemas/Settings" } } } }, "actions": { "type": "array", "description": "Array containing previous changing order actions history.", "items": { "type": "object", "description": "Changing order action details, with a schema like the `requests` property.", "nullable": true } } } }, "example": { "requests": [ { "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", "reason": "The client did not like the size.", "manualDiscountValue": 0, "manualIncrementValue": 0, "totalChangeValue": 0, "totals": [ { "id": "ManualValues", "name": "Manual Values Total", "value": -1000 } ], "add": null, "remove": null, "replace": [ { "from": { "paymentData": { "transactions": [] }, "items": [ { "id": "31", "quantity": 1, "price": 5000, "measurementUnit": "un", "unitMultiplier": 1, "sellingPrice": 5000, "name": "Small toy", "detailUrl": "/small-toy-24/p", "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" } ], "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "DeliverClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 180, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "31", "deliveryChannels": [ { "id": "delivery" } ], "price": 180, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 180, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } }, "to": { "items": [ { "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", "id": "1", "productId": "1", "productRefId": "", "refId": "codrefxicaraazul", "ean": "8745121641", "name": "Blue cup", "skuName": "cup", "modalType": null, "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": null, "tax": 0, "price": 5000, "listPrice": null, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": 5000, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": null, "brandId": null, "offeringInfo": null, "offeringType": null, "offeringTypeId": null, "categoriesIds": null, "productClusterId": null, "commercialConditionId": null }, "preSaleDate": null, "productCategoryIds": "/1/", "productCategories": { "1": "Category" }, "quantity": 1, "seller": "1", "sellerChain": [ "1" ], "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", "detailUrl": "/xicara/p", "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": null, "measurementUnit": "un", "unitMultiplier": 1, "manufacturerCode": null, "priceDefinition": { "calculatedSellingPrice": 5000, "total": 5000, "sellingPrices": [ { "value": 5000, "quantity": 1 } ] } } ], "paymentData": { "transactions": [] }, "receiptData": null, "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 600, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "1", "deliveryChannels": [ { "id": "delivery" } ], "price": 600, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 600, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "Donkey", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } } } ], "date": "2024-07-27T17:52:18.6483116Z", "origin": { "account": "qastore", "orderId": "v12772213qst-02", "component": "MarketplaceComponent" }, "settings": { "customPaymentSystemsAllowed": [ "201" ] } } ], "actions": [] } } } } } } }, "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}": { "get": { "tags": [ "Change order (beta)" ], "summary": "Get order change details", "description": "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `inProgress`: When set as `true`, the order is still progressing in the order flow, when set as `false`, it is complete, whether by cancellation or because the customer received it.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "operationId": "GetChangeDetail", "parameters": [ { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order you wish to get the change detail.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } }, { "name": "changeRequestId", "in": "path", "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. There are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", "required": true, "style": "simple", "schema": { "type": "string", "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "requestId", "workflowId", "status", "inProgress", "reason", "manualDiscountValue", "manualIncrementValue", "totalChangeValue", "totals", "add", "remove", "replace", "date", "origin", "settings" ], "type": "object", "properties": { "requestId": { "type": "string", "description": "Unique code that identifies a change order request." }, "workflowId": { "type": "string", "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." }, "status": { "type": "string", "description": "Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." }, "inProgress": { "type": "boolean", "description": "When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the customer received it." }, "reason": { "type": "string", "description": "Reason that motivated the order change." }, "manualDiscountValue": { "type": "integer", "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." }, "manualIncrementValue": { "type": "integer", "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." }, "totalChangeValue": { "type": "integer", "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." }, "totals": { "type": "array", "description": "Array containing total costs information.", "items": { "type": "object", "description": "Total changing price details for a given type of cost.", "properties": { "id": { "type": "string", "description": "Changing price type, for example the item price or shipping costs." }, "name": { "type": "string", "description": "Changing price name." }, "value": { "type": "number", "description": "Changing price value in cents." } } } }, "add": { "type": "array", "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", "nullable": true, "items": { "type": "string", "description": "Adding operation information, when applicable." } }, "remove": { "type": "array", "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", "nullable": true, "items": { "type": "string", "description": "Removing operation information, when applicable." } }, "replace": { "type": "array", "description": "Array with information about the `replace` operation, when applicable.", "items": { "$ref": "#/components/schemas/Replace1" } }, "date": { "type": "string", "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." }, "origin": { "$ref": "#/components/schemas/OriginV2" }, "settings": { "$ref": "#/components/schemas/Settings" } } }, "example": { "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", "status": "done", "inProgress": false, "reason": "The client did not like the size.", "manualDiscountValue": 0, "manualIncrementValue": 0, "totalChangeValue": 0, "totals": [ { "id": "ManualValues", "name": "Manual Values Total", "value": -1000 } ], "add": null, "remove": null, "replace": [ { "from": { "paymentData": { "transactions": [] }, "items": [ { "id": "31", "quantity": 1, "price": 5000, "measurementUnit": "un", "unitMultiplier": 1, "sellingPrice": 5000, "name": "Small toy", "detailUrl": "/small-toy-24/p", "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" } ], "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "DeliverClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 180, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "31", "deliveryChannels": [ { "id": "delivery" } ], "price": 180, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 180, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } }, "to": { "items": [ { "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", "id": "1", "productId": "1", "productRefId": "", "refId": "codrefxicaraazul", "ean": "8745121641", "name": "Blue cup", "skuName": "cup", "modalType": null, "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": null, "tax": 0, "price": 5000, "listPrice": null, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": 5000, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": null, "brandId": null, "offeringInfo": null, "offeringType": null, "offeringTypeId": null, "categoriesIds": null, "productClusterId": null, "commercialConditionId": null }, "preSaleDate": null, "productCategoryIds": "/1/", "productCategories": { "1": "Category" }, "quantity": 1, "seller": "1", "sellerChain": [ "1" ], "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", "detailUrl": "/xicara/p", "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": null, "measurementUnit": "un", "unitMultiplier": 1, "manufacturerCode": null, "priceDefinition": { "calculatedSellingPrice": 5000, "total": 5000, "sellingPrices": [ { "value": 5000, "quantity": 1 } ] } } ], "paymentData": { "transactions": [] }, "receiptData": null, "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 600, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "1", "deliveryChannels": [ { "id": "delivery" } ], "price": 600, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 600, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "Donkey", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } } } ], "date": "2024-07-27T17:52:18.6483116Z", "origin": { "account": "qastore", "orderId": "v12772213qst-02", "component": "MarketplaceComponent" }, "settings": { "customPaymentSystemsAllowed": [ "201" ] } } } } } } } }, "/api/order-system/orders/{changeOrderId}/changes/preview": { "post": { "tags": [ "Change order (beta)" ], "summary": "Preview order change", "operationId": "PreviewChange", "description": "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, and the response body of a successful request provides a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order you wish to preview change.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "reason", "replace" ], "type": "object", "properties": { "reason": { "type": "string", "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", "example": "The client wants to change a weighable product." }, "replace": { "type": "array", "items": { "$ref": "#/components/schemas/Replace" }, "description": "Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "reason", "manualDiscountValue", "manualIncrementValue", "totalChangeValue", "totals", "add", "remove", "replace", "date", "origin", "settings" ], "properties": { "reason": { "type": "string", "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh)." }, "manualDiscountValue": { "type": "integer", "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." }, "manualIncrementValue": { "type": "integer", "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." }, "totalChangeValue": { "type": "integer", "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." }, "totals": { "type": "array", "description": "Array containing total costs information.", "items": { "type": "object", "description": "Total changing price details for a given type of cost.", "properties": { "id": { "type": "string", "description": "Changing price type, for example the item price or shipping costs." }, "name": { "type": "string", "description": "Changing price name." }, "value": { "type": "number", "description": "Changing price value in cents." } } } }, "add": { "type": "array", "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", "nullable": true, "items": { "type": "string", "description": "Adding operation information, when applicable." } }, "remove": { "type": "array", "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", "nullable": true, "items": { "type": "string", "description": "Removing operation information, when applicable." } }, "replace": { "type": "array", "description": "Array with information about the `replace` operation, when applicable.", "items": { "type": "object", "description": "Replacing operation object.", "required": [ "from", "to" ], "properties": { "from": { "$ref": "#/components/schemas/From2" }, "to": { "$ref": "#/components/schemas/To2" } } } }, "date": { "type": "string", "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." }, "origin": { "$ref": "#/components/schemas/OriginV2" }, "settings": { "$ref": "#/components/schemas/Settings" } } }, "example": { "reason": "I would like to receive a preview.", "manualDiscountValue": 0, "manualIncrementValue": 0, "totalChangeValue": 420, "totals": [ { "id": "ManualValues", "name": "Manual Values Total", "value": 0 }, { "id": "Shipping", "name": "Shipping Total", "value": 420 } ], "add": null, "remove": null, "replace": [ { "from": { "paymentData": { "transactions": [] }, "items": [ { "id": "31", "quantity": 1, "price": 5000, "measurementUnit": "un", "unitMultiplier": 1, "sellingPrice": 5000, "name": "Small toy", "detailUrl": "/small-toy-24/p", "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" } ], "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "DeliverClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 180, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "31", "deliveryChannels": [ { "id": "delivery" } ], "price": 180, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 180, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } }, "to": { "items": [ { "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", "id": "1", "productId": "1", "productRefId": "", "refId": "codrefxicaraazul", "ean": "8745121641", "name": "Blue cup", "skuName": "cup", "modalType": null, "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": null, "tax": 0, "price": 5000, "listPrice": null, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": 5000, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": null, "brandId": null, "offeringInfo": null, "offeringType": null, "offeringTypeId": null, "categoriesIds": null, "productClusterId": null, "commercialConditionId": null }, "preSaleDate": null, "productCategoryIds": "/1/", "productCategories": { "1": "Category" }, "quantity": 1, "seller": "1", "sellerChain": [ "1" ], "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", "detailUrl": "/xicara/p", "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": null, "measurementUnit": "un", "unitMultiplier": 1, "manufacturerCode": null, "priceDefinition": { "calculatedSellingPrice": 5000, "total": 5000, "sellingPrices": [ { "value": 5000, "quantity": 1 } ] } } ], "paymentData": { "transactions": [] }, "receiptData": null, "shippingData": { "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Economic", "selectedDeliveryChannel": "delivery", "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", "slas": [ { "id": "Economic", "deliveryChannel": "delivery", "name": "Economic", "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 600, "listPrice": 180, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" }, { "id": "Normal", "deliveryChannel": "delivery", "name": "Normal", "deliveryIds": [ { "courierId": "1", "warehouseId": "1_1", "dockId": "1", "courierName": "CourierClass", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "3bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 500, "listPrice": 500, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "3bd" }, { "id": "Pickup", "deliveryChannel": "delivery", "name": "Pickup", "deliveryIds": [ { "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", "courierName": "Pickup", "quantity": 1, "kitItemDetails": [], "accountCarrierName": null } ], "shippingEstimate": "25bd", "shippingEstimateDate": null, "lockTTL": "12d", "availableDeliveryWindows": [], "deliveryWindow": null, "price": 700, "listPrice": 700, "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupPointId": null, "pickupDistance": null, "polygonName": "", "transitTime": "25bd" } ], "shipsTo": [ "BRA" ], "itemId": "1", "deliveryChannels": [ { "id": "delivery" } ], "price": 600, "listPrice": 180, "shippingEstimate": "25bd", "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", "deliveryCompany": null, "polygonName": "", "transitTime": "25bd", "sellingPrice": 600, "deliveryIds": [ { "courierId": "1c083bf", "warehouseId": "1_1", "dockId": "1", "courierName": "Donkey", "quantity": 1, "kitItemDetails": null, "accountCarrierName": "qastoreecho" } ], "deliveryWindow": null, "pickupPointId": null, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null }, "pickupDistance": null } ] } } } ], "date": "2024-07-27T17:52:18.6483116Z", "origin": { "account": "qastore", "orderId": "v12772213qst-02", "component": "MarketplaceComponent" }, "settings": { "customPaymentSystemsAllowed": [ "201" ] } } } } } } } }, "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry": { "post": { "tags": [ "Change order (beta)" ], "summary": "Retry order change", "operationId": "RetryChange", "description": "This endpoint makes a new attempt to perform an order change previously made using the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) request. When you retry to change an order using the `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order you wish to retry change.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } }, { "name": "changeRequestId", "in": "path", "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", "required": true, "style": "simple", "schema": { "type": "string", "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Createchange" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel": { "post": { "tags": [ "Change order (beta)" ], "summary": "Cancel order change", "operationId": "CancelChangeStoppedonError", "description": "This endpoint cancels an [order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a change was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to [create a new order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "an", "in": "query", "description": "Name of the VTEX account that created the order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storeName" } }, { "name": "changeOrderId", "in": "path", "description": "Order ID of the order with the changes you wish to cancel.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } }, { "name": "changeRequestId", "in": "path", "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. After cancelling an order change, the `changeRequestId` will no longer be valid.", "required": true, "style": "simple", "schema": { "type": "string", "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "description": "Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.", "example": "I want to cancel this change order request because it's stopped on a blocking error." } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/order-system/orders/changes/settings": { "put": { "tags": [ "Change order (beta)" ], "summary": "Update Change order settings", "description": "Updates the [Change order](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) settings from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |
Cancel order<\/p>
Change order<\/p> |\r\n| inStore Sales Person |
Cancel order<\/p>
Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "an", "in": "query", "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "storename" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentConfiguration": { "type": "object", "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.", "properties": { "customPaymentSystemsAllowed": { "type": "array", "description": "List of custom payment system IDs configured for the VTEX account.", "items": { "type": "string", "description": "Payment system ID.", "example": "201" } } } }, "rolloutConfiguration": { "type": "object", "description": "**Change order** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.", "properties": { "enableApi": { "type": "boolean", "description": "Defines if the account enabled the [Change order API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Change order via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.", "default": false, "example": true }, "enableAdminOrders": { "type": "object", "description": "Object about enabling the [Change order feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).", "properties": { "enabledWorkspaces": { "type": "array", "description": "List with the workspaces' names that have the **Change order** feature enabled via VTEX Admin.", "items": { "type": "string", "description": "Name of the workspace with **Change order** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces.", "example": "*" } } } }, "enableMyOrders": { "type": "object", "description": "Object about enabling the **Change order** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", "properties": { "enabledWorkspaces": { "type": "array", "description": "List with the workspaces' names that have the **Change order** feature enabled via **My Account**.", "items": { "type": "string", "description": "Name of the workspace with **Change order** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces.", "example": "storename" } } } } } }, "pipelineConfiguration": { "type": "object", "description": "**Change order** settings related to taxes and shipping calculation.", "properties": { "enableTaxHubRecalculation": { "type": "boolean", "description": "Defines if the tax calculation is enabled for **Change order** (`true`) or not (`false`).", "default": false, "example": false }, "compensateShippingChanges": { "type": "boolean", "description": "Defines if the orders changed will have zero shipping cost (`true`) or not (`false`). Merchants can enable this configuration to change only items and prices, without impacting the orders' original freight costs.", "default": true, "example": true } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOrderSettingsResponse" }, "example": { "paymentConfiguration": { "customPaymentSystemsAllowed": [ "201", "125" ] }, "rolloutConfiguration": { "usingDefaultBehavior": false, "enableApi": true, "enableAdminOrders": { "enabledWorkspaces": [ "*" ] }, "enableMyOrders": { "enabledWorkspaces": [ "*" ] } }, "pipelineConfiguration": { "enableTaxHubRecalculation": false, "compensateShippingChanges": true } } } } } } }, "get": { "tags": [ "Change order (beta)" ], "summary": "Get Change order settings", "description": "Retrieves the [Change order settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings) from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "an", "in": "query", "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "mystore" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOrderSettingsResponse" }, "example": { "paymentConfiguration": { "customPaymentSystemsAllowed": [ "201", "125" ] }, "rolloutConfiguration": { "usingDefaultBehavior": false, "enableApi": true, "enableAdminOrders": { "enabledWorkspaces": [ "*" ] }, "enableMyOrders": { "enabledWorkspaces": [ "*" ] } }, "pipelineConfiguration": { "enableTaxHubRecalculation": false, "compensateShippingChanges": true } } } } } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "parameters": { "UNUSED_incompleteOrders": { "name": "incompleteOrders", "in": "query", "description": "You can use this parameter to filter [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders) by their situations, whether permanent (`perm`) or temporary (`temp`). When the situation is temporary, the order is still opened and has not being cancelled. To filter the total number of incomplete orders, use the value `all`.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "all" } } }, "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } }, "schemas": { "TotalsUpdated": { "type": "array", "description": "Information about the order totals.", "items": { "type": "object", "description": "Details about the order totals.", "properties": { "id": { "type": "string", "description": "Total ID, which defines what the total is about.", "enum": [ "Items", "Discounts", "Shipping", "Tax" ] }, "name": { "type": "string", "description": "Total name." }, "value": { "type": "integer", "description": "Total value in cents." }, "alternativeTotals": { "type": "array", "description": "Information about the order alternative totals, when applicable. For example, when there is a discount for items in the marketplace that results in a difference in the `Items` total value, the `alternativeTotals` can retrieve details about it.", "nullable": true, "items": { "type": "object", "description": "Details about the order alternative totals.", "properties": { "id": { "type": "string", "description": "Alternative total ID, which can be related to items, discounts, shipping or taxes." }, "name": { "type": "string", "description": "Alternative total name." }, "value": { "type": "integer", "description": "Alternative total value in cents." } } } } } } }, "ItemsUpdated": { "type": "array", "description": "Information on order items.", "items": { "type": "object", "description": "Information on each order item.", "properties": { "uniqueId": { "type": "string", "description": "Order item unique ID." }, "id": { "type": "string", "description": "Item ID." }, "productId": { "type": "string", "description": "Product ID." }, "ean": { "type": "string", "description": "European Article Number (EAN) of the item.", "nullable": true }, "lockId": { "type": "string", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.", "nullable": true }, "attachments": { "type": "array", "description": "Information about [attachments](https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).", "nullable": true, "items": { "type": "object", "description": "Information about a given attachment.", "properties": { "name": { "type": "string", "description": "Attachment name.", "nullable": true }, "content": { "type": "object", "description": "Custom field for attachment content.", "nullable": true, "additionalProperties": { "type": "string", "description": "Attachment custom field content.", "nullable": true } } } } }, "quantity": { "type": "integer", "description": "Item quantity." }, "seller": { "type": "string", "description": "Seller name. When the store acts both as marketplace and seller, this field corresponds to `1`, because every VTEX store is its own seller 1." }, "name": { "type": "string", "description": "SKU name." }, "refId": { "type": "string", "description": "Ref ID." }, "price": { "type": "integer", "description": "Item price in cents." }, "listPrice": { "type": "integer", "description": "List price in cents." }, "manualPrice": { "type": "integer", "description": "[Manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf) in cents.", "nullable": true }, "manualPriceAppliedBy": { "type": "string", "description": "ID of the user who applied the manual price.", "nullable": true }, "priceTags": { "type": "array", "description": "Information about price tags. A price tag is a price modifier, like s discount or a promotion applicable to the item in the order context.", "items": { "type": "object", "description": "Information about a given price tag.", "properties": { "name": { "type": "string", "description": "Price tag name." }, "value": { "type": "number", "description": "Price tag value in cents. Discounts correspond to negative numbers.", "nullable": true }, "isPercentual": { "type": "boolean", "description": "Defines if the price tag value is applied through a percentage (`true`) or not (`false`)." }, "identifier": { "type": "string", "description": "Price tag identifier." }, "rawValue": { "type": "number", "description": "Price tag raw value." }, "rate": { "type": "integer", "description": "Price tag rate.", "nullable": true }, "jurisCode": { "type": "string", "description": "Juris code.", "nullable": true }, "jurisType": { "type": "string", "description": "Juris type.", "nullable": true }, "jurisName": { "type": "string", "description": "Juris name.", "nullable": true } } } }, "imageUrl": { "type": "string", "description": "Image URL." }, "detailUrl": { "type": "string", "description": "Detail URL." }, "components": { "type": "array", "description": "Item components.", "nullable": true, "items": { "type": "string", "description": "Component name.", "nullable": true } }, "bundleItems": { "type": "array", "description": "Information about services sold with the item. For example, a gift package.", "nullable": true, "items": { "type": "object", "description": "Information about a given service.", "properties": { "type": { "type": "string", "description": "Service type." }, "id": { "type": "integer", "description": "Service ID." }, "name": { "type": "string", "description": "Service name." }, "price": { "type": "integer", "description": "Service price in cents." } } } }, "params": { "type": "array", "description": "Array with information about params.", "items": { "type": "string", "description": "Param name." } }, "offerings": { "type": "array", "description": "Information about offerings, which are services related to the item. For example, a warranty or installation.", "nullable": true, "items": { "type": "string", "description": "Name of the service related to the item.", "nullable": true } }, "attachmentOfferings": { "type": "array", "description": "Array containing attachments information.", "nullable": true, "items": { "type": "object", "description": "Attachment details.", "nullable": true, "properties": { "name": { "type": "string", "description": "Attachment name.", "nullable": true }, "required": { "type": "boolean", "description": "Defines if the attachment is required (`true`) or not (`false`).", "nullable": true }, "schema": { "type": "object", "description": "Schema of the content declared in the field `attachmentOfferings`.", "nullable": true, "additionalProperties": { "type": "string", "description": "Attachment schema content.", "nullable": true } } } } }, "sellerSku": { "type": "string", "description": "Seller SKU ID." }, "priceValidUntil": { "type": "string", "description": "Item price expiration date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "nullable": true }, "commission": { "type": "integer", "description": "Commission value registered for the seller." }, "tax": { "type": "integer", "description": "Tax value in cents." }, "preSaleDate": { "type": "string", "description": "Presale date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "nullable": true }, "additionalInfo": { "type": "object", "description": "Item additional information.", "properties": { "brandName": { "type": "string", "description": "Item brand name." }, "brandId": { "type": "string", "description": "Item brand ID." }, "categoriesIds": { "type": "string", "description": "Categories IDs." }, "categories": { "type": "array", "description": "Item [categories](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) information.", "items": { "type": "object", "description": "Information about a given category.", "properties": { "id": { "type": "integer", "description": "Category ID." }, "name": { "type": "string", "description": "Category name." } } } }, "productClusterId": { "type": "string", "description": "All product clusters related to the item." }, "commercialConditionId": { "type": "string", "description": "Commercial condition ID." }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "offeringInfo": { "type": "string", "description": "Offering information.", "nullable": true }, "offeringType": { "type": "string", "description": "Offering type.", "nullable": true }, "offeringTypeId": { "type": "string", "description": "Offering type ID.", "nullable": true } } }, "measurementUnit": { "type": "string", "description": "Item measurement unit." }, "unitMultiplier": { "type": "number", "description": "Item unit multiplier." }, "sellingPrice": { "type": "integer", "description": "Selling price in cents. This field can present rounding discrepancies, so we recommend retrieving pricing information from the `priceDefinition` field." }, "isGift": { "type": "boolean", "description": "Defines it the item is a gift (`true`) or not (`false`)." }, "shippingPrice": { "type": "integer", "description": "Item shipping price in cents. This value does not account for the order total shipping price.", "nullable": true }, "rewardValue": { "type": "integer", "description": "Reward value in cents." }, "freightCommission": { "type": "integer", "description": "Freight commission value in cents." }, "priceDefinition": { "type": "object", "description": "Item price information.", "properties": { "sellingPrices": { "type": "array", "description": "Item selling prices.", "items": { "type": "object", "description": "Price value per quantity.", "properties": { "value": { "type": "integer", "description": "Item selling price value in cents." }, "quantity": { "type": "integer", "description": "Item quantity." } } } }, "calculatedSellingPrice": { "type": "integer", "description": "Item calculated selling price in cents." }, "total": { "type": "integer", "description": "Item total price in cents." }, "reason": { "type": "string", "description": "Item price definition reason.", "nullable": true } } }, "taxCode": { "type": "string", "description": " Item tax code.", "nullable": true }, "parentItemIndex": { "type": "integer", "description": "Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.", "nullable": true }, "parentAssemblyBinding": { "type": "string", "description": "When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).", "nullable": true }, "callCenterOperator": { "type": "string", "description": "Identification code of the call center operator that sold the item, when applicable.", "nullable": true }, "serialNumbers": { "type": "string", "description": "This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.", "deprecated": true, "nullable": true }, "assemblies": { "type": "array", "description": "Information about the item customization, when applicable.", "nullable": true, "items": { "type": "string", "description": "Customization information.", "nullable": true } }, "costPrice": { "type": "integer", "description": "Item cost price in cents.", "nullable": true } } } }, "ClientProfileDataUpdated": { "type": "object", "description": "Information about the customer profile.", "properties": { "id": { "type": "string", "description": "Object ID, the expected value is `clientProfileData`." }, "email": { "type": "string", "description": "Customer email." }, "firstName": { "type": "string", "description": "Customer first name." }, "lastName": { "type": "string", "description": "Customer last name." }, "documentType": { "type": "string", "description": "Type of the document informed by the customer." }, "document": { "type": "string", "description": "Document identification code informed by the customer." }, "phone": { "type": "string", "description": "Customer phone number." }, "corporateName": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, this field includes the corporate name." }, "tradeName": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, this field includes the trade name." }, "corporateDocument": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, this field includes the corporate document." }, "stateInscription": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, this field includes the state inscription." }, "corporatePhone": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, this field includes the company's phone number." }, "isCorporate": { "type": "boolean", "description": "Defines if the customer is a legal entity (`true`) or not (`false`)." }, "userProfileId": { "type": "string", "description": "Customer user profile ID." }, "userProfileVersion": { "type": "string", "nullable": true, "description": "Customer user profile version." }, "customerClass": { "type": "string", "nullable": true, "description": "Customer class identification." }, "customerCode": { "type": "string", "nullable": true, "description": "Customer code." } } }, "GiftRegistryDataUpdated": { "type": "object", "description": "[Gift list](https://developers.vtex.com/docs/guides/creating-gift-lists) information.", "nullable": true, "properties": { "giftRegistryId": { "type": "string", "description": "Gift list ID." }, "giftRegistryType": { "type": "string", "description": "[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list)." }, "giftRegistryTypeName": { "type": "string", "description": "Gift list type name." }, "addressId": { "type": "string", "description": "Gift list shipping address ID." }, "description": { "type": "string", "description": "Gift list description." } } }, "MarketingDataUpdated": { "type": "object", "description": "Information about marketing and promotions, such as coupon code and [Urchin Tracking Module (UTM)](https://help.vtex.com/en/tutorial/what-are-utm-source-utm-campaign-and-utm-medium--2wTz7QJ8KUG6skGAoAQuii).", "nullable": true, "properties": { "id": { "type": "string", "description": "Object ID. The expected value is `marketingData`." }, "utmSource": { "type": "string", "description": "A UTM is an Urchin Tracking Module used to track traffic related to your store. This field is an UTM for tracking the traffic source, to know from which site, advertiser, or publication the customer came before reaching your site.", "nullable": true }, "utmPartner": { "type": "string", "description": "UTM for tracking the partner.", "nullable": true }, "utmMedium": { "type": "string", "description": "UTM for tracking the advertising or marketing media used to reach your site, such as banners and newsletters." }, "utmCampaign": { "type": "string", "description": "UTM for tracking the marketing campaign context.", "nullable": true }, "coupon": { "type": "string", "description": "Coupon code used by the customer.", "nullable": true }, "utmiCampaign": { "type": "string", "description": "Internal UTM for tracking the marketing campaign context.", "nullable": true }, "utmipage": { "type": "string", "description": "A `utmi` is an internal Urchin Tracking Module (UTM) used to track traffic inside your site. This field is an internal UTM for tracking pages.", "nullable": true }, "utmiPart": { "type": "string", "description": "Internal UTM for tracking the partner.", "nullable": true }, "marketingTags": { "type": "array", "description": "List of marketing tags valid for the item.", "items": { "type": "string", "description": "Marketing tag name." } } } }, "RatesAndBenefitsDataUpdated": { "type": "object", "description": "Information on promotions and taxes that apply to the order.", "properties": { "id": { "type": "string", "description": "Object ID. The expected value is `ratesAndBenefitsData`." }, "rateAndBenefitsIdentifiers": { "type": "array", "description": "Information about order's promotions and taxes identifiers.", "items": { "type": "object", "description": "Information about a given promotion or tax.", "properties": { "description": { "type": "string", "description": "Promotion or tax description.", "nullable": true }, "featured": { "type": "boolean", "description": "Defines if the [target audience](https://help.vtex.com/en/tutorial/creating-a-campaign-audience--6cnuDZJzIkIeocewAQQK4K) is featured (`true`) or not (`false`)." }, "id": { "type": "string", "description": "Promotion or tax ID." }, "name": { "type": "string", "description": "Promotion or tax name." }, "matchedParameters": { "type": "object", "description": "Informs the criteria and conditions fulfilled so the promotion became valid.", "additionalProperties": { "type": "string", "description": "Promotion or tax criteria content." } }, "additionalInfo": { "type": "object", "description": "Object containing the promotion or tax additional information.", "nullable": true, "additionalProperties": { "type": "string", "description": "Additional information." } } } } } } }, "ShippingDataUpdated": { "type": "object", "description": "Order shipping information.", "properties": { "id": { "type": "string", "description": "Object ID. The expected value is `shippingData`." }, "address": { "type": "object", "description": "Shipping address details.", "required": [ "addressType", "receiverName", "addressId", "postalCode", "city", "state", "country", "street", "number", "neighborhood", "complement", "reference", "geoCoordinates" ], "properties": { "addressType": { "type": "string", "description": "Shipping address type.", "enum": [ "residential", "pickup" ] }, "receiverName": { "type": "string", "description": "Full name of the order receiver." }, "addressId": { "type": "string", "description": "Shipping address ID." }, "versionId": { "type": "string", "description": "Shipping address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Shipping address entity ID.", "nullable": true }, "postalCode": { "type": "string", "description": "Shipping address postal code." }, "city": { "type": "string", "description": "Shipping address city." }, "state": { "type": "string", "description": "Shipping address state." }, "country": { "type": "string", "description": "Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "street": { "type": "string", "description": "Shipping address street." }, "number": { "type": "string", "description": "Shipping address number." }, "neighborhood": { "type": "string", "description": "Shipping address neighborhood." }, "complement": { "type": "string", "description": "Shipping address complement.", "nullable": true }, "reference": { "type": "string", "description": "Shipping address additional information.", "nullable": true }, "geoCoordinates": { "type": "array", "description": "Shipping address pair of geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } } } }, "logisticsInfo": { "type": "array", "description": "Logistics information regarding order items.", "items": { "type": "object", "description": "Logistics information about an item.", "properties": { "itemIndex": { "type": "integer", "description": "Each item in the order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on." }, "itemId": { "type": "string", "description": "SKU ID." }, "selectedDeliveryChannel": { "type": "string", "description": "Delivery channel selected by the customer. This field is being deprecated and the information it retrieves can be found in the `deliveryChannel` field.", "deprecated": true, "enum": [ "delivery", "pickup-in-point" ] }, "selectedSla": { "type": "string", "description": "Service Level Agreement (SLA), which corresponds to the shipping method selected by the customer, usually like normal or express." }, "lockTTL": { "type": "string", "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time." }, "price": { "type": "integer", "description": "Item shipping price in cents. This value does not correspond to the order total shipping price." }, "listPrice": { "type": "integer", "description": "Item [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price) in cents." }, "sellingPrice": { "type": "integer", "description": "Item selling price in cents." }, "deliveryWindow": { "type": "string", "description": "[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, when applicable.", "nullable": true }, "deliveryCompany": { "type": "string", "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company name." }, "shippingEstimate": { "type": "string", "description": "Shipping estimate time in days. For instance, three business days is represented `3bd`." }, "shippingEstimateDate": { "type": "string", "description": "Shipping estimate date, defined after order confirmation, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "slas": { "type": "array", "description": "Service Level Agreements (SLA) corresponding to [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", "items": { "type": "object", "description": "Service Level Agreement (SLA) information.", "properties": { "id": { "type": "string", "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)." }, "name": { "type": "string", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name." }, "shippingEstimate": { "type": "string", "description": "Shipping estimate time in days. For instance, three business days is represented `3bd`." }, "shippingEstimateDate": { "type": "string", "description": "SLA shipping estimate date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "nullable": true }, "deliveryWindow": { "type": "string", "description": "[Delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", "nullable": true }, "availableDeliveryWindows": { "type": "array", "description": "Available delivery windows information, when applicable.", "nullable": true, "items": { "type": "string", "description": "Information about an available delivery window." } }, "deliveryIds": { "type": "array", "description": "SLA delivery IDs information.", "items": { "type": "object", "description": "Information about a delivery ID.", "properties": { "courierId": { "type": "string", "description": "Carrier ID." }, "courierName": { "type": "string", "description": "Carrier name." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "quantity": { "type": "integer", "description": "Quantity of items being delivered." }, "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "accountCarrierName": { "type": "string", "description": "Account carrier name." }, "kitItemDetails": { "type": "array", "description": "Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.", "nullable": true, "items": { "type": "string", "description": "Kit item information." } } } } }, "listPrice": { "type": "integer", "description": "SLA shipping list price in cents." }, "price": { "type": "integer", "description": "SLA shipping price in cents. Does not account for the order total shipping price." }, "deliveryChannel": { "type": "string", "description": "Defines if the delivery channel is delivery or [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "enum": [ "delivery", "pickup-in-point" ] }, "pickupStoreInfo": { "$ref": "#/components/schemas/PickupStoreInfoUpdated" }, "polygonName": { "type": "string", "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", "nullable": true }, "lockTTL": { "type": "string", "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time related to the SLA." }, "pickupPointId": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.", "nullable": true }, "transitTime": { "type": "string", "description": "Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`." }, "pickupDistance": { "type": "number", "description": "Distance in kilometers between the pickup point and the customer address. The distance is measured as a straight line.", "nullable": true } } } }, "shipsTo": { "type": "array", "description": "List of shipping address countries.", "items": { "type": "string", "description": "Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." } }, "deliveryIds": { "type": "array", "description": "Order delivery IDs information.", "items": { "type": "object", "description": "Information about a delivery ID.", "properties": { "courierId": { "type": "string", "description": "Carrier ID." }, "courierName": { "type": "string", "description": "Carrier name." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "quantity": { "type": "integer", "description": "Quantity of items being delivered." }, "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "accountCarrierName": { "type": "string", "description": "Account carrier name." }, "kitItemDetails": { "type": "array", "description": "Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.", "nullable": true, "items": { "type": "string", "description": "Kit item information." } } } } }, "deliveryChannels": { "type": "array", "description": "Delivery channels associated with the sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)).", "items": { "type": "object", "description": "Delivery channel information.", "properties": { "id": { "type": "string", "description": "Delivery channel shipping type.", "enum": [ "delivery", "pickup-in-point" ] }, "stockBalance": { "type": "integer", "description": "Stock check for SKU availability." } } } }, "deliveryChannel": { "type": "string", "description": "Defines if the delivery channel is delivery or pickup. This field is deprecated and was replaced by the `deliveryChannels` field.", "deprecated": true, "enum": [ "delivery", "pickup-in-point" ] }, "pickupStoreInfo": { "$ref": "#/components/schemas/PickupStoreInfoUpdated" }, "addressId": { "type": "string", "description": "Shipping address ID.", "nullable": true }, "versionId": { "type": "string", "description": "Shipping address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Shipping address entity ID.", "nullable": true }, "polygonName": { "type": "string", "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", "nullable": true }, "pickupPointId": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID, when applicable.", "nullable": true }, "transitTime": { "type": "string", "description": "Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`." } } } }, "trackingHints": { "type": "array", "description": "Order shipping label information.", "nullable": true, "items": { "type": "object", "description": "Shipping label details.", "properties": { "trackingId": { "type": "string", "description": "Order tracking ID." }, "courierName": { "type": "string", "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) name." }, "trackingUrl": { "type": "string", "description": "Order tracking URL." }, "trackingLabel": { "type": "string", "description": "Order tracking label." } } } }, "selectedAddresses": { "type": "array", "description": "Selected adresses information.", "items": { "type": "object", "description": "Details about a selected adress.", "properties": { "addressId": { "type": "string", "description": "Selected address ID." }, "versionId": { "type": "string", "description": "Selected address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Selected address entity ID.", "nullable": true }, "addressType": { "type": "string", "description": "Selected adress shipping type.", "enum": [ "residential", "pickup" ] }, "receiverName": { "type": "string", "description": "Full name of the order receiver." }, "street": { "type": "string", "description": "Selected address street." }, "number": { "type": "string", "description": "Selected address number." }, "complement": { "type": "string", "description": "Selected address complement.", "nullable": true }, "neighborhood": { "type": "string", "description": "Selected address neighborhood." }, "postalCode": { "type": "string", "description": "Selected address postal code." }, "city": { "type": "string", "description": "Selected address city." }, "state": { "type": "string", "description": "Selected address state." }, "country": { "type": "string", "description": "Selected address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "reference": { "type": "string", "nullable": true, "description": "Selected address additional information." }, "geoCoordinates": { "type": "array", "description": "Selected address pair of geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } } } } }, "availableAddresses": { "type": "array", "description": "Available adresses information.", "items": { "type": "object", "description": "Details about an available adress.", "properties": { "addressId": { "type": "string", "description": "Available address ID." }, "versionId": { "type": "string", "description": "Available address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Available address entity ID.", "nullable": true }, "addressType": { "type": "string", "description": "Available adress shipping type.", "enum": [ "residential", "pickup" ] }, "receiverName": { "type": "string", "description": "Full name of the order receiver." }, "street": { "type": "string", "description": "Available address street." }, "number": { "type": "string", "description": "Available address number." }, "complement": { "type": "string", "description": "Available address complement.", "nullable": true }, "neighborhood": { "type": "string", "description": "Available address neighborhood." }, "postalCode": { "type": "string", "description": "Available address postal code." }, "city": { "type": "string", "description": "Available address city." }, "state": { "type": "string", "description": "Available address state." }, "country": { "type": "string", "description": "Available address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "reference": { "type": "string", "nullable": true, "description": "Available address additional information." }, "geoCoordinates": { "type": "array", "description": "Available address pair of geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } } } } }, "contactInformation": { "type": "array", "description": "Order contact information.", "nullable": true, "items": { "type": "object", "description": "Order contact details.", "properties": { "id": { "type": "string", "description": "Contact ID." }, "email": { "type": "string", "description": "Contact email." }, "firstName": { "type": "string", "description": "Contact first name." }, "lastName": { "type": "string", "description": "Contact last name." }, "document": { "type": "string", "description": "Contact document number." }, "phone": { "type": "string", "description": "Contact phone number." }, "documentType": { "type": "string", "description": "Contact document type." } } } } } }, "PickupStoreInfoUpdated": { "type": "object", "description": "Information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "required": [ "additionalInfo", "address", "dockId", "friendlyName", "isPickupStore" ], "properties": { "isPickupStore": { "type": "boolean", "description": "Defines if the shipping type was pickup (`true`) or not (`false`)." }, "friendlyName": { "type": "string", "description": "Name of the pickup point displayed at checkout.", "nullable": true }, "address": { "type": "object", "description": "Pickup point address information.", "nullable": true, "properties": { "postalCode": { "type": "string", "description": "Pickup point address postal code." }, "country": { "type": "string", "description": "Three-digit country code of the pickup point address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "city": { "type": "string", "description": "Pickup point address city." }, "state": { "type": "string", "description": "Pickup point address state." }, "neighborhood": { "type": "string", "description": "Pickup point address neighborhood." }, "street": { "type": "string", "description": "Pickup point address street." }, "number": { "type": "string", "description": "Pickup point address number." }, "complement": { "type": "string", "description": "Pickup point address complement." }, "reference": { "type": "string", "description": "Pickup point address reference.", "nullable": true }, "location": { "type": "object", "description": "Pickup point geolocation coordinates.", "properties": { "latitude": { "type": "number", "description": "Latitude coordinate." }, "longitude": { "type": "number", "description": "Longitude coordinate." } } } } }, "additionalInfo": { "type": "string", "description": "Additional information.", "nullable": true }, "dockId": { "type": "string", "description": "ID of the loading dock related to the pickup point.", "nullable": true } } }, "PaymentDataUpdated": { "type": "object", "description": "Payments information.", "properties": { "giftCards": { "type": "array", "description": "[Gift cards](https://developers.vtex.com/docs/guides/gift-card-integration-guide) information, when applicable.", "nullable": true, "items": { "type": "object", "description": "Gift card details.", "properties": { "id": { "type": "string", "description": "Gift card identification." }, "redemptionCode": { "type": "string", "description": "Gift card code used by the customer at checkout." }, "name": { "type": "string", "description": "Gift card name.", "nullable": true }, "caption": { "type": "string", "description": "Gift card loyalty program, when applicable.", "nullable": true }, "value": { "type": "integer", "description": "Gift card value in cents." }, "balance": { "type": "number", "description": "Gift card current balance. For newly created gift cards, the balance will be `0.0`." }, "provider": { "type": "string", "description": "Gift card provider name." }, "groupName": { "type": "string", "description": "Gift card group name.", "nullable": true }, "inUse": { "type": "boolean", "description": "Defines if the gift card is in use (`true`) or not (`false`)." }, "isSpecialCard": { "type": "boolean", "description": "Defines if the gift card is a special card (`true`) or not (`false`)." } } } }, "transactions": { "type": "array", "description": "Information about the order financial transactions.", "items": { "type": "object", "description": "Information about a given transaction.", "properties": { "isActive": { "type": "boolean", "description": "Defines of the transaction is active (`true`) or inactive (`false`)." }, "transactionId": { "type": "string", "description": "Transaction ID." }, "merchantName": { "type": "string", "description": "Merchant name." }, "payments": { "type": "array", "description": "Payments information.", "items": { "type": "object", "description": "Payment details.", "properties": { "id": { "type": "string", "description": "Payment unique identifier." }, "paymentSystem": { "type": "string", "description": "Payment system ID." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "value": { "type": "integer", "description": "Order total payment value in cents." }, "installments": { "type": "integer", "description": "Number of payment installments." }, "referenceValue": { "type": "integer", "description": "Total payment reference value in cents." }, "cardHolder": { "type": "string", "nullable": true, "description": "Name of the card owner." }, "cardNumber": { "type": "string", "nullable": true, "description": "Card number." }, "firstDigits": { "type": "string", "nullable": true, "description": "Card first four digits." }, "lastDigits": { "type": "string", "nullable": true, "description": "Card last four digits." }, "cvv2": { "type": "string", "nullable": true, "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions." }, "expireMonth": { "type": "string", "nullable": true, "description": "Card expiration month in 2-digit format." }, "expireYear": { "type": "string", "description": "Card expiration year in 4-digit format.", "nullable": true }, "url": { "type": "string", "description": "Payment URL.", "nullable": true }, "giftCardId": { "type": "string", "description": "Gift card ID.", "nullable": true }, "giftCardName": { "type": "string", "description": "Gift card name.", "nullable": true }, "giftCardCaption": { "type": "string", "description": "Gift card caption.", "nullable": true }, "redemptionCode": { "type": "string", "description": "Gift card code used by the customer at checkout.", "nullable": true }, "group": { "type": "string", "description": "Transaction payment method, which can be credit card, debid card, bank invoice, promissory, gift card or pix (`instantPayment`).", "enum": [ "creditCard", "debitCard", "bankInvoice", "promissory", "giftCard", "instantPayment" ] }, "tid": { "type": "string", "description": "Provider unique identifier for the transaction." }, "dueDate": { "type": "string", "description": "Payment due date in `MM/YY` format.", "nullable": true }, "connectorResponses": { "type": "object", "description": "Payment provider (connector) responses. The fields within this object can vary according to the order payment provider.", "properties": { "Message": { "type": "string", "description": "Provider operational message or error to be logged.", "nullable": true }, "tid": { "type": "string", "description": "Provider unique identifier for the transaction." }, "authorizationId": { "type": "string", "description": "Provider authorization ID." }, "status": { "type": "string", "description": "Order payment status in the [transaction flow](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y)." }, "delayToAutoSettle": { "type": "integer", "description": "Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`, regardless if the payment was approved by the merchant's anti-fraud provider. The maximum value allowed is `604800` seconds (7 days)." }, "ReturnCode": { "type": "string", "description": "Provider operational return code or error to be logged.", "nullable": true }, "nsu": { "type": "string", "description": "Provider unique sequential number for the transaction." }, "code": { "type": "string", "description": "Provider operational code or error to be logged." }, "message": { "type": "string", "description": "Provider operational message or error to be logged." }, "Tid": { "type": "string", "description": "Provider unique identifier for the transaction." }, "acquirer": { "type": "string", "description": "[Acquirer](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#acquirer) name (mostly used for card payments)." }, "authId": { "type": "string", "description": "Authorization identification." }, "paymentId": { "type": "string", "description": "Payment ID." }, "delayToAutoSettleAfterAntifraud": { "type": "string", "description": "Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`. This happens only after the payment was approved by the merchant's anti-fraud provider." } } }, "giftCardProvider": { "type": "string", "description": "Gift card provider ID.", "nullable": true }, "giftCardAsDiscount": { "type": "boolean", "description": "Defines if the payment has a gift card discount (`true`) or not (`false`).", "nullable": true }, "koinUrl": { "type": "string", "description": "Koin connector URL.", "nullable": true }, "accountId": { "type": "string", "description": "Identification code of the account where the payment was made.", "nullable": true }, "parentAccountId": { "type": "string", "description": "When the payment was made in a subaccount, this field retrieves the main account ID.", "nullable": true }, "bankIssuedInvoiceIdentificationNumber": { "type": "string", "description": "Bank issued invoice numeric sequence.", "nullable": true }, "bankIssuedInvoiceIdentificationNumberFormatted": { "type": "string", "description": "Bank issued invoice numeric sequence formatted as customers see.", "nullable": true }, "bankIssuedInvoiceBarCodeNumber": { "type": "string", "description": "Bank issued invoice bar code number.", "nullable": true }, "bankIssuedInvoiceBarCodeType": { "type": "string", "description": "Bank issued invoice bar code type.", "nullable": true }, "billingAddress": { "type": "object", "description": "Billing address information.", "nullable": true, "properties": { "postalCode": { "type": "string", "description": "Billing address postal code." }, "city": { "type": "string", "description": "Billing address city." }, "state": { "type": "string", "description": "Billing address state." }, "country": { "type": "string", "description": "Billing address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "street": { "type": "string", "description": "Billing address street." }, "number": { "type": "string", "description": "Billing address number." }, "neighborhood": { "type": "string", "description": "Billing address neighborhood." }, "complement": { "type": "string", "description": "Billing address complement.", "nullable": true }, "reference": { "type": "string", "description": "Billing address additional information.", "nullable": true }, "geoCoordinates": { "type": "array", "description": "Billing address pair of geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } } } }, "paymentOrigin": { "type": "string", "description": "Type of [wallet](https://help.vtex.com/en/tutorial/what-is-an-e-wallet--4v5wcOe4A0SiaimWM2cU60) used in the payment.", "nullable": true } } } } } } } } }, "PackageAttachmentUpdated": { "type": "object", "description": "Information about shipping packages, which are created after order invoicing.", "nullable": true, "properties": { "packages": { "type": "array", "description": "List with packages' information.", "nullable": true, "items": { "type": "object", "description": "Package details.", "properties": { "courier": { "type": "string", "description": "Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping." }, "description": { "type": "string", "description": "Package description.", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Unique identification code of the package invoice." }, "invoiceValue": { "type": "integer", "description": "Package invoice value in cents." }, "invoiceUrl": { "type": "string", "description": "Package invoice URL." }, "issuanceDate": { "type": "string", "description": "Package invoice issuance date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "trackingNumber": { "type": "string", "description": "Package [tracking number](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)." }, "invoiceKey": { "type": "string", "description": "Package invoice key." }, "trackingUrl": { "type": "string", "description": "Package tracking URL." }, "embeddedInvoice": { "type": "string", "description": "Package invoice text in [xml format](https://help.vtex.com/en/tutorial/configuring-xml--tutorials_242). This field is important for stores integrated with [external marketplaces](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)." }, "type": { "type": "string", "description": "Package invoice type, which can be:\r\n- `Output`: Selling order invoice.\r\n- `Input`: Returning items invoice.", "enum": [ "Output", "Input" ] }, "items": { "type": "array", "description": "Information on each item in the package.", "items": { "type": "object", "description": "Package item details.", "properties": { "itemIndex": { "type": "integer", "description": "Item index of the item position whithin the `items` array. The count starts at `0`." }, "id": { "type": "string", "description": "SKU ID." }, "quantity": { "type": "integer", "description": "Package item quantity." }, "price": { "type": "integer", "description": "Package item price in cents." }, "description": { "type": "string", "description": "Package item description." }, "unitMultiplier": { "type": "number", "description": "Package item unit multiplier." } } } }, "courierStatus": { "type": "object", "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) shipping information.", "nullable": true, "properties": { "deliveredDate": { "type": "string", "description": "Package delivery date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "status": { "type": "string", "description": "Defines if a carrier was assigned for order shipping (`ok`) or not (`null`).", "nullable": true }, "finished": { "type": "boolean", "description": "Defines if the carrier has already delivered the package (`true`) or not (`false`)." }, "data": { "type": "array", "description": "Package tracking information.", "items": { "type": "object", "description": "Package tracking details.", "properties": { "lastChange": { "type": "string", "description": "Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "city": { "type": "string", "description": "Package tracking city." }, "state": { "type": "string", "description": "Package tracking state in two-digit code format." }, "description": { "type": "string", "description": "Package tracking description." }, "createDate": { "type": "string", "description": "Package tracking creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." } } } } } }, "cfop": { "type": "string", "description": "[CFOP](https://www.gov.br/receitafederal/pt-br/acesso-a-informacao/acoes-e-programas/facilitacao/anexo-ecf-cfop) (_Código Fiscal de Operação e Prestação_) is a Brazilian fiscal code of operations and services that classifies business transaction types.", "nullable": true }, "lastChange": { "type": "string", "description": "Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "restitutions": { "type": "object", "description": "Information about a value being returned to the customer. This field applies only to invoices with the `Input` type because it relates to returning items.", "nullable": true, "properties": { "refund": { "type": "object", "description": "Customer refund details.", "properties": { "value": { "type": "integer", "description": "Refund value in cents." }, "giftCardData": { "type": "string", "description": "Refund involving a [gift card](https://developers.vtex.com/docs/guides/gift-card-integration-guide).", "nullable": true }, "items": { "type": "array", "description": "Information about the items being returned.", "nullable": true, "items": { "type": "object", "description": "Returned item details.", "properties": { "useFreight": { "type": "boolean", "description": "Defines if the refund includes freight values (`true`) or not (`false`).", "nullable": true }, "isCompensation": { "type": "boolean", "description": "Defines if there are compensated unit tags in the package (`true`) or not (`false`)." }, "compensationValue": { "type": "integer", "description": "Compensational refund value in cents." }, "id": { "type": "string", "description": "SKU ID of the returned item." }, "quantity": { "type": "integer", "description": "Number of items being returned." }, "price": { "type": "integer", "description": "Returned item price in cents." }, "description": { "type": "string", "description": "Customer reason for returning the item." } } } } } } } }, "volumes": { "type": "integer", "description": "Indicates the number of boxes (volumes) needed to contain the package items. For example, two refrigerators do not fit in a single volume, so this field would have value `2`.", "nullable": true } } } } } }, "SellersUpdated": { "type": "array", "description": "Information about the sellers associated with the order.", "items": { "type": "object", "description": "Information about a given seller.", "properties": { "id": { "type": "string", "description": "Seller identifier." }, "name": { "type": "string", "description": "Seller name." }, "logo": { "type": "string", "description": "Seller logo URL.", "nullable": true }, "fulfillmentEndpoint": { "type": "string", "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace use to communicate with the seller." } } } }, "InvoiceDataUpdated": { "type": "object", "description": "Order invoices information.", "nullable": true, "properties": { "address": { "type": "object", "description": "Invoice address information.", "nullable": true, "properties": { "addressType": { "type": "string", "description": "Invoice address type, which can be `residential`, when the customer gives an address for delivery, or `pickup`, when the customer picks the order at a pickup point.", "nullable": true, "enum": [ "residential", "pickup" ] }, "receiverName": { "type": "string", "description": "Full name of the order receiver.", "nullable": true }, "addressId": { "type": "string", "description": "Invoice address ID.", "nullable": true }, "versionId": { "type": "string", "description": "Invoice address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Invoice address entity ID.", "nullable": true }, "postalCode": { "type": "string", "description": "Invoice address postal code." }, "city": { "type": "string", "description": "Invoice address city." }, "state": { "type": "string", "description": "Invoice address state." }, "country": { "type": "string", "description": "Invoice address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "street": { "type": "string", "description": "Invoice address street." }, "number": { "type": "string", "description": "Invoice address number." }, "neighborhood": { "type": "string", "description": "Invoice address neighborhood." }, "complement": { "type": "string", "description": "Invoice address complement.", "nullable": true }, "reference": { "type": "string", "description": "Invoice address additional information.", "nullable": true }, "geoCoordinates": { "type": "array", "description": "Invoice address pair of geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } }, "contactId": { "type": "string", "description": "Contact unique identifier.", "nullable": true } } }, "userPaymentInfo": { "type": "object", "description": "Invoice information regarding payment method.", "nullable": true, "properties": { "paymentMethods": { "type": "array", "description": "List of the payment methods used by the customer in the purchase.", "items": { "type": "string", "description": "Payment method name." } } } }, "invoiceSubject": { "type": "object", "description": "Information about the invoice subject.", "nullable": true, "properties": { "id": { "type": "string", "description": "Invoice subject ID." }, "email": { "type": "string", "description": "Invoice subject email address." }, "firstName": { "type": "string", "description": "Invoice subject first name." }, "lastName": { "type": "string", "description": "Invoice subject last name." }, "phone": { "type": "string", "description": "Invoice subject phone number." } } } } }, "ChangesAttachmentUpdated": { "type": "object", "description": "Information about changes in the order.", "nullable": true, "required": [ "id", "changesData" ], "properties": { "id": { "type": "string", "description": "Order changes ID." }, "changesData": { "type": "array", "description": "Information about changes in the order.", "items": { "required": [ "reason", "discountValue", "incrementValue", "itemsAdded", "itemsRemoved", "receipt" ], "type": "object", "description": "Details about an order change.", "properties": { "reason": { "type": "string", "description": "Text explaining why the order was changed. This information may be shown to the customer in the storefront or transactional emails." }, "discountValue": { "type": "integer", "description": "Order change discount value in cents.", "nullable": true }, "incrementValue": { "type": "integer", "description": "Order change increment value in cents.", "nullable": true }, "itemsAdded": { "type": "array", "description": "Information about items added to the order, when applicable.", "nullable": true, "items": { "type": "object", "description": "Information about an item added to the order.", "properties": { "id": { "type": "string", "description": "Added item SKU ID." }, "name": { "type": "string", "description": "Added item SKU name." }, "quantity": { "type": "integer", "description": "Quantity of items added." }, "price": { "type": "integer", "description": "Added item price in cents." }, "unitMultiplier": { "type": "string", "description": "Added item unit multiplier.", "nullable": true } } } }, "itemsRemoved": { "type": "array", "description": "Information about items removed from the order, when applicable.", "nullable": true, "items": { "type": "object", "description": "Information about an item removed from the order.", "required": [ "id", "name", "quantity", "price", "unitMultiplier" ], "properties": { "id": { "type": "string", "description": "Removed item SKU ID." }, "name": { "type": "string", "description": "Removed item name." }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of removed items." }, "price": { "type": "integer", "format": "int32", "description": "Removed item price in cents." }, "unitMultiplier": { "type": "string", "description": "Removed item unit multiplier.", "nullable": true } } } }, "receipt": { "required": [ "date", "orderId", "receipt" ], "type": "object", "description": "Order changes receipt information.", "properties": { "date": { "type": "string", "description": "Receipt creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "orderId": { "type": "string", "description": "Order ID." }, "receipt": { "type": "string", "description": "Receipt unique identifier code." } } } } } } } }, "CallCenterOperatorDataUpdated": { "type": "object", "description": "Information about the call center operator responsible for the order.", "nullable": true, "properties": { "id": { "type": "string", "description": "Call center operator identification code." }, "email": { "type": "string", "description": "Call center operator email." }, "userName": { "type": "string", "description": "Call center operator user name." } } }, "StorePreferencesDataUpdated": { "type": "object", "description": "Store preferences in the [Account settings](https://help.vtex.com/en/tutorial/account-details-page--2vhUVOKfCaswqLguT2F9xq) page.", "properties": { "countryCode": { "type": "string", "description": "Country code in three-digit [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "currencyCode": { "type": "string", "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." }, "currencyFormatInfo": { "type": "object", "description": "Currency format settings.", "properties": { "CurrencyDecimalDigits": { "type": "integer", "description": "Number of currency decimal digits." }, "CurrencyDecimalSeparator": { "type": "string", "description": "Character for currency decimal separation." }, "CurrencyGroupSeparator": { "type": "string", "description": "Character for currency group separation." }, "CurrencyGroupSize": { "type": "integer", "description": "Limit of characters that can be grouped for currency groups." }, "StartsWithCurrencySymbol": { "type": "boolean", "description": "Defines if the prices displayed for customers start with the currency symbol (`true`) or not (`false`)." } } }, "currencyLocale": { "type": "integer", "description": "Currency locale code in [LCID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) format." }, "currencySymbol": { "type": "string", "description": "Currency symbol characters." }, "timeZone": { "type": "string", "description": "Time zone considered for the store orders." } } }, "MarketplaceUpdated": { "type": "object", "description": "Information about the marketplace related to the order.", "nullable": true, "properties": { "baseURL": { "type": "string", "description": "Marketplace base URL." }, "isCertified": { "type": "boolean", "nullable": true, "description": "Defines if the marketplace is a [VTEX certified marketplace](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-certified-marketplaces) (`true`) or not (`false`)." }, "name": { "type": "string", "description": "Marketplace name." } } }, "ItemMetadataUpdated": { "type": "object", "description": "Metadata information about items.", "properties": { "Items": { "type": "array", "description": "Metadata details about items.", "items": { "type": "object", "description": "Metadata details about a given item", "properties": { "Id": { "type": "string", "description": "SKU ID." }, "Seller": { "type": "string", "description": "Seller ID." }, "Name": { "type": "string", "description": "Item name as displayed to customers in the storefront." }, "SkuName": { "type": "string", "description": "SKU name." }, "ProductId": { "type": "string", "description": "Product ID." }, "RefId": { "type": "string", "description": "SKU reference ID." }, "Ean": { "type": "string", "description": "European Article Number (EAN) of the item.", "nullable": true }, "ImageUrl": { "type": "string", "description": "SKU image URL." }, "DetailUrl": { "type": "string", "description": "SKU slug." }, "AssemblyOptions": { "type": "array", "description": "[Assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) information related to the item, when applicable.", "nullable": true, "items": { "type": "object", "description": "[Assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) details.", "properties": { "Id": { "type": "string", "description": "Assembly option ID." }, "Name": { "type": "string", "description": "Assembly option name." }, "Required": { "type": "boolean", "description": "Defines if sending the attachment for the item purchased is required(`true`) or optional (`false`)." }, "InputValues": { "type": "object", "description": "Assembly option content.", "nullable": true, "additionalProperties": { "type": "string", "description": "Assembly option value.", "nullable": true } }, "Composition": { "type": "object", "description": "Assembly option composition.", "nullable": true, "additionalProperties": { "type": "string", "description": "Assembly option composition value." } } } } } } } } } }, "SubscriptionDataUpdated": { "type": "object", "description": "Information about [subscriptions](https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable.", "nullable": true, "properties": { "subscriptionGroupId": { "type": "string", "description": "Subscription group ID. If this field returns `null` and the `executionCount` is `0`, the order is the first subscription order.", "nullable": true }, "subscriptions": { "type": "array", "description": "List with subscriptions details.", "nullable": true, "items": { "type": "object", "description": "Subscription details.", "properties": { "executionCount": { "type": "integer", "description": "Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on." }, "priceAtSubscriptionDate": { "type": "number", "description": "Value of the order when the customer subscribed. Subscriptions created via VTEX Admin or [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) do not have an original order, so this field returns `0.0`.", "nullable": true, "deprecated": true }, "itemIndex": { "type": "integer", "description": "Each item in the subscription order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on." }, "plan": { "type": "object", "description": "Information about the [subscription plan](https://help.vtex.com/en/tutorial/subscription-plans-beta--5kczKRqHEsrs1tYtRcY8wR).", "properties": { "type": { "type": "string", "description": "Plan type." }, "frequency": { "type": "object", "description": "Information about the subscription recurrence.", "properties": { "periodicity": { "type": "string", "description": "Defines the subscription recurrence period.", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "interval": { "type": "integer", "description": "Time interval configured between subscription orders, which depends on the frequency. For a `DAY` frequency, the value will be days, for `MONTH` it will be months, and so on." } } }, "validity": { "type": "object", "description": "Information about the period during which the subscription will be valid.", "properties": { "begin": { "type": "string", "description": "Subscription plan beginning date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "end": { "type": "string", "description": "Subscription plan ending date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "nullable": true } } } } } } } } } }, "TaxDataUpdated": { "type": "object", "description": "Order taxes information.", "required": [ "areTaxesDesignatedByMarketplace", "taxInfoCollection" ], "nullable": true, "properties": { "areTaxesDesignatedByMarketplace": { "type": "boolean", "description": "Defines if the taxes were applied by the marketplace (`true`) or not (`false`)." }, "taxInfoCollection": { "type": "array", "description": "Order taxes details.", "items": { "type": "object", "description": "Information about a given tax.", "required": [ "itemIndex", "sku", "priceTags" ], "properties": { "itemIndex": { "type": "integer", "description": "Item indexing number." }, "sku": { "type": "string", "description": "SKU ID." }, "priceTags": { "type": "array", "description": "Price tags information.", "nullable": true, "items": { "type": "object", "description": "Information about a given price tag.", "properties": { "identifier": { "type": "string", "description": "Price tag identifier code." }, "isPercentual": { "type": "boolean", "description": "Indicates whether price tag value is applied through a percentage (`true`) or not (`false`)." }, "name": { "type": "string", "description": "Price tag name." }, "value": { "type": "integer", "description": "Price tag value in cents." }, "rawValue": { "type": "number", "description": "Price tag raw value that can contain up to five decimals, separated by a period." } } } } } } } } }, "CancellationDataUpdated": { "type": "object", "description": "Information about [order cancellation](https://developers.vtex.com/docs/guides/order-canceling-improvements), when applicable.", "nullable": true, "properties": { "requestedByUser": { "type": "boolean", "description": "Defines if the order cancellation was requested by the customer (`true`) or not (`false`)." }, "requestedBySystem": { "type": "boolean", "description": "Defines if the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.", "nullable": true }, "requestedBySellerNotification": { "type": "boolean", "description": "Defines if the order cancellation was requested by the seller (`true`) or not (`false`).", "nullable": true }, "requestedByPaymentNotification": { "type": "boolean", "description": "Defines if the order cancellation was requested by the payment gateway (`true`) or not (`false`).", "nullable": true }, "reason": { "type": "string", "description": "Reason why the order was canceled." }, "cancellationDate": { "type": "string", "description": "Order cancellation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "cancellationRequestId": { "type": "string", "description": "ID that identifies the cancellation operation." } } }, "CancellationRequestsUpdated": { "type": "array", "description": "Information about the [seller order cancellation denials](https://developers.vtex.com/docs/guides/order-canceling-improvements), regardless if the cancellation request was made by the marketplace or the customer.", "nullable": true, "items": { "type": "object", "description": "Information about the seller denial to a given order cancellation request.", "properties": { "id": { "type": "string", "description": "ID that identifies the original cancellation operation made by the marketplaces or its customer care service using the [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel) endpoint." }, "reason": { "type": "string", "description": "Reason why there was a request to cancel the order." }, "cancellationRequestDate": { "type": "string", "description": "Date of when the order cancellation request was processed by the platform. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "requestedByUser": { "type": "boolean", "description": "Defines if the order cancellation was requested by the customer (`true`) or not (`false`)." }, "deniedBySeller": { "type": "boolean", "description": "Defines if the order cancellation request was [denied by the seller](https://developers.vtex.com/docs/guides/order-canceling-improvements) (`true`) or accepted by the seller (`false`)." }, "deniedBySellerReason": { "type": "string", "description": "Reason given by the seller for denying the order cancellation.", "nullable": true }, "cancellationRequestDenyDate": { "type": "string", "description": "Date of when the platform processed the seller denial to an order cancellation request. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "nullable": true } } } }, "ClientPreferencesDataUpdated": { "type": "object", "description": "Information about the customer preferences.", "properties": { "locale": { "type": "string", "description": "Language code of the customer preferred language while accessing the store." }, "optinNewsLetter": { "type": "boolean", "description": "Defines if the customer receives the store's newsletter (`true`) or not (`false`)." } } }, "Total": { "required": ["id", "name", "value"], "type": "object", "description": "Object about order's totals.", "properties": { "id": { "type": "string", "description": "Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`." }, "name": { "type": "string", "description": "Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`." }, "value": { "type": "integer", "description": "Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`." } } }, "Item": { "required": [ "uniqueId", "id", "productId", "ean", "lockId", "itemAttachment", "attachments", "quantity", "seller", "name", "refId", "price", "listPrice", "manualPrice", "priceTags", "imageUrl", "detailUrl", "components", "bundleItems", "params", "offerings", "attachmentOfferings", "sellerSku", "priceValidUntil", "commission", "tax", "preSaleDate", "additionalInfo", "measurementUnit", "unitMultiplier", "sellingPrice", "isGift", "shippingPrice", "rewardValue", "freightCommission", "priceDefinitions", "taxCode", "parentItemIndex", "parentAssemblyBinding", "callCenterOperator", "serialNumbers", "assemblies", "costPrice" ], "type": "object", "description": "Item details.", "properties": { "uniqueId": { "type": "string", "description": "Unique ID is an alphanumeric sequence that identifies an SKU in a given order." }, "id": { "type": "string", "description": "Item's SKU ID, which is a unique numerical identifier." }, "productId": { "type": "string", "description": "ID of the Product associated with the item." }, "ean": { "type": "string", "nullable": true, "description": "EAN of the SKU." }, "lockId": { "type": "string", "description": "Reservation ID." }, "itemAttachment": { "$ref": "#/components/schemas/ItemAttachment" }, "attachments": { "type": "array", "items": { "type": "string", "description": "Attachment details." }, "description": "Array containing information on attachments." }, "quantity": { "type": "integer", "description": "Quantity of items." }, "seller": { "type": "string", "description": "Seller related to the order." }, "name": { "type": "string", "description": "Item's name." }, "refId": { "type": "string", "description": "Product referencial code associated with the item." }, "price": { "type": "integer", "description": "Item's price." }, "listPrice": { "type": "integer", "description": "Item's list price." }, "manualPrice": { "type": "string", "nullable": true, "description": "Item's manual price." }, "priceTags": { "type": "array", "items": { "type": "string", "description": "Price modifier." }, "description": "List of objects with item's price modifiers." }, "imageUrl": { "type": "string", "description": "Item's SKU image URL." }, "detailUrl": { "type": "string", "description": "URL slug of the item." }, "components": { "type": "array", "items": { "type": "string", "description": "A given component." }, "description": "Item's components." }, "bundleItems": { "type": "array", "items": { "type": "string", "description": "Item offering details." }, "description": "This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering." }, "params": { "type": "array", "items": { "type": "string", "description": "Param name." }, "description": "Information about params." }, "offerings": { "type": "array", "items": { "type": "string", "description": "Name of the service related to the item. For example, guarantee or installation." }, "description": "Item's offerings, which are services related to the item. For example, guarantee or installation." }, "attachmentOfferings": { "type": "array", "description": "List of attachments details.", "nullable": true, "items": { "type": "object", "description": "Attachment details.", "required": ["name", "required", "schema"], "properties": { "name": { "type": "string", "description": "Name of the attachment.", "nullable": true }, "required": { "type": "boolean", "description": "If the attachment is required (`true`) or not (`false`).", "nullable": true }, "schema": { "type": "object", "description": "Schema of the content declared in the field `attachmentOfferings`.", "nullable": true } } } }, "sellerSku": { "type": "string", "description": "SKU ID from the seller perspective." }, "priceValidUntil": { "type": "string", "nullable": true, "description": "Date until when the price is going to be valid if there is a promotion." }, "commission": { "type": "integer", "description": "Commission value registered for the seller." }, "tax": { "type": "integer", "description": "Item's tax." }, "preSaleDate": { "type": "string", "nullable": true, "description": "Item's pre sale date." }, "additionalInfo": { "$ref": "#/components/schemas/AdditionalInfo" }, "measurementUnit": { "type": "string", "description": "Item's measurement unit." }, "unitMultiplier": { "type": "integer", "description": "Item's unit multiplier." }, "sellingPrice": { "type": "integer", "description": "Item's selling price." }, "isGift": { "type": "boolean", "description": "This field is `true` when the item is a gift in order context and `false` when it is not." }, "shippingPrice": { "type": "string", "nullable": true, "description": "Item's shipping price." }, "rewardValue": { "type": "integer", "description": "Item's reward value." }, "freightCommission": { "type": "integer", "description": "Value of the freight commission." }, "priceDefinitions": { "type": "object", "description": "Item's price information.", "required": [ "sellingPrices", "calculatedSellingPrice", "total" ], "properties": { "sellingPrices": { "type": "array", "items": { "type": "object", "description": "Item value and quantity.", "required": ["value", "quantity"], "properties": { "value": { "type": "integer", "description": "Total value of items in cents." }, "quantity": { "type": "integer", "description": "Quantity of items." } } }, "description": "Details on item's selling price." }, "calculatedSellingPrice": { "type": "integer", "description": "Item's calculated unitary selling price in cents." }, "total": { "type": "integer", "description": "Total value of all item's units in cents." } } }, "taxCode": { "type": "string", "nullable": true, "description": " Item's tax code." }, "parentItemIndex": { "type": "string", "nullable": true, "description": "Parent item index." }, "parentAssemblyBinding": { "type": "string", "nullable": true, "description": "Parent assembly binding." }, "callCenterOperator": { "type": "string", "description": "Call center operator responsible for the order.", "nullable": true }, "serialNumbers": { "type": "string", "description": "This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.", "deprecated": true, "nullable": true }, "assemblies": { "type": "array", "description": "Retrieves information about orders item's customizations.", "nullable": true, "items": { "type": "string", "description": "Customization information." } }, "costPrice": { "type": "integer", "description": "Item's cost price." } } }, "ItemAttachment": { "title": "ItemAttachment", "description": "Information about attachments, if it applies.", "required": ["content", "name"], "type": "object", "properties": { "content": { "type": "object", "description": "Attachment's custom field for content." }, "name": { "type": "string", "nullable": true, "description": "Attachment's name." } }, "example": { "content": {}, "name": null } }, "AdditionalInfo": { "title": "AdditionalInfo", "description": "Additional information about the item.", "required": [ "brandName", "brandId", "categoriesIds", "productClusterId", "commercialConditionId", "dimension", "offeringInfo", "offeringType", "offeringTypeId" ], "type": "object", "properties": { "brandName": { "type": "string", "description": "Item's brand name." }, "brandId": { "type": "string", "description": "Item's brand ID." }, "categoriesIds": { "type": "string", "description": "Item's category ID." }, "productClusterId": { "type": "string", "description": "All product clusters related to the item." }, "commercialConditionId": { "type": "string", "description": "Commercial conditions ID." }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "offeringInfo": { "type": "string", "nullable": true, "description": "Information about services related to the item. For example: guarantee or installation." }, "offeringType": { "type": "string", "nullable": true, "description": "Offering type." }, "offeringTypeId": { "type": "string", "nullable": true, "description": "Offering type ID." } }, "example": { "brandName": "VTEX", "brandId": "2000023", "categoriesIds": "/1/", "productClusterId": "135,142", "commercialConditionId": "5", "dimension": { "cubicweight": 0.7031, "height": 15, "length": 15, "weight": 15, "width": 15 }, "offeringInfo": null, "offeringType": null, "offeringTypeId": null } }, "Dimension": { "type": "object", "description": "Item dimensions.", "required": [ "cubicweight", "height", "length", "weight", "width" ], "properties": { "cubicweight": { "type": "number", "description": "Item cubic weight." }, "height": { "type": "number", "description": "Item height." }, "length": { "type": "number", "description": "Item length." }, "weight": { "type": "number", "description": "Item weight." }, "width": { "type": "number", "description": "Item width." } } }, "ClientProfileData": { "title": "ClientProfileData", "description": "Object with information on the client's profile.", "required": [ "id", "email", "firstName", "lastName", "documentType", "document", "phone", "corporateName", "tradeName", "corporateDocument", "stateInscription", "corporatePhone", "isCorporate", "userProfileId", "customerClass" ], "type": "object", "properties": { "id": { "type": "string", "description": "Object ID, the expected value is `clientProfileData`." }, "email": { "type": "string", "description": "Customer's email." }, "firstName": { "type": "string", "description": "Customer's first name." }, "lastName": { "type": "string", "description": "Customer's last name." }, "documentType": { "type": "string", "description": "Type of the document informed by the customer." }, "document": { "type": "string", "description": "Document identification code informed by the customer." }, "phone": { "type": "string", "description": "Customers's phone number." }, "corporateName": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, here goes the corporate name." }, "tradeName": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, here goes the trade name." }, "corporateDocument": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, here goes the corporate document." }, "stateInscription": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, here goes the state inscription." }, "corporatePhone": { "type": "string", "nullable": true, "description": "If the customer is a legal entity, here goes the corpany's phone number." }, "isCorporate": { "type": "boolean", "description": "The value is `true` when the customer is a legal entity and `false` when not." }, "userProfileId": { "type": "string", "description": "Customer user profile ID." }, "customerClass": { "type": "string", "nullable": true, "description": "Identification of the class the customer belongs to." } }, "example": { "id": "clientProfileData", "email": "rodrigo.cunha@vtex.com.br", "firstName": "Rodrigo", "lastName": "VTEX", "documentType": "cpf", "document": "11047867702", "phone": "+5521972321094", "corporateName": null, "tradeName": null, "corporateDocument": null, "stateInscription": null, "corporatePhone": null, "isCorporate": false, "userProfileId": "5a3692de-358a-4bea-8885-044bce33bb93", "customerClass": null } }, "RatesAndBenefitsData": { "title": "RatesAndBenefitsData", "description": "Information on promotions and taxes that apply to the order.", "required": ["id", "rateAndBenefitsIdentifiers"], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the rate or benefit." }, "rateAndBenefitsIdentifiers": { "type": "array", "items": { "type": "string" }, "description": "Information about order's promotions and taxes identifiers." } }, "example": { "id": "ratesAndBenefitsData", "rateAndBenefitsIdentifiers": [] } }, "ShippingData": { "title": "ShippingData", "description": "Object containing shipping data.", "required": [ "id", "address", "logisticsInfo", "trackingHints", "selectedAddresses" ], "type": "object", "properties": { "id": { "type": "string", "description": "Object ID, the expected value is `shippingData`." }, "address": { "$ref": "#/components/schemas/Address" }, "logisticsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/LogisticsInfo" }, "description": "Array of objects containing item's logistics information." }, "trackingHints": { "type": "string", "nullable": true }, "selectedAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedAddress" }, "description": "Information about selected adresses." } }, "example": { "id": "shippingData", "address": { "addressType": "residential", "receiverName": "Rodrigo Cunha", "addressId": "-1425945657910", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "postalCode": "22250-040", "city": "Rio de Janeiro", "state": "RJ", "country": "BRA", "street": "Praia de Botafogo", "number": "300", "neighborhood": "Botafogo", "complement": "3", "reference": null, "geoCoordinates": [] }, "logisticsInfo": [ { "itemIndex": 0, "selectedSla": "Normal", "lockTTL": "10d", "price": 1160, "listPrice": 1160, "sellingPrice": 1160, "deliveryWindow": null, "deliveryCompany": "Todos os CEPS", "shippingEstimate": "5bd", "shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00", "slas": [ { "id": "Normal", "name": "Normal", "shippingEstimate": "5bd", "deliveryWindow": null, "price": 1160, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "", "lockTTL": "12d", "pickupPointId": "store35", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Expressa", "name": "Expressa", "shippingEstimate": "5bd", "deliveryWindow": null, "price": 1160, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "", "lockTTL": "12d", "pickupPointId": "store45", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Quebra Kit", "name": "Quebra Kit", "shippingEstimate": "2bd", "deliveryWindow": null, "price": 1392, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "", "lockTTL": "12d", "pickupPointId": "store45", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Sob Encomenda", "name": "Sob Encomenda", "shippingEstimate": "32bd", "deliveryWindow": null, "price": 1392, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "", "lockTTL": "12d", "pickupPointId": "store46", "transitTime": "3d", "pickupDistance": 0.0 } ], "shipsTo": ["BRA"], "deliveryIds": [ { "courierId": "197a56f", "courierName": "Todos os CEPS", "dockId": "1", "quantity": 1, "warehouseId": "1_1", "accountCarrierName": "recorrenciaqa", "kitItemDetails": [] } ], "deliveryChannels": [ { "id": "delivery", "stockBalance": 0 } ], "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "addressId": "4791759472332", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "polygonName": "", "pickupPointId": "store67", "transitTime": "3d" } ], "trackingHints": null, "selectedAddresses": [ { "addressId": "-1425945657910", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "addressType": "residential", "receiverName": "Rodrigo Cunha", "street": "Praia de Botafogo", "number": "518", "complement": "10", "neighborhood": "Botafogo", "postalCode": "22250-040", "city": "Rio de Janeiro", "state": "RJ", "country": "BRA", "reference": null, "geoCoordinates": [] } ] } }, "Address": { "title": "Address", "description": "Shipping address details.", "required": [ "addressType", "receiverName", "addressId", "versionId", "entityId", "postalCode", "city", "state", "country", "street", "number", "neighborhood", "complement", "reference", "geoCoordinates" ], "type": "object", "properties": { "addressType": { "type": "string", "description": "Type of address. For example, `Residential` or `Pickup`, among others." }, "receiverName": { "type": "string", "description": "Name of the person who is going to receive the order." }, "addressId": { "type": "string", "description": "Shipping address ID." }, "versionId": { "type": "string", "description": "Shipping address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Shipping address entity ID.", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code of the shipping address." }, "city": { "type": "string", "description": "City of the shipping address." }, "state": { "type": "string", "description": "State of the shipping address." }, "country": { "type": "string", "description": "Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3)." }, "street": { "type": "string", "description": "Street of the shipping address." }, "number": { "type": "string", "description": "Number of the building, house or apartment in the shipping address." }, "neighborhood": { "type": "string", "description": "Neighborhood of the shipping address." }, "complement": { "type": "string", "description": "Complement to the shipping address when it applies." }, "reference": { "type": "string", "nullable": true, "description": "Complement to help locate the shipping address, in case of delivery." }, "geoCoordinates": { "type": "array", "items": { "type": "number" }, "description": "Array with two numbers with geocoordinates, first longitude then latitude." } }, "example": { "addressType": "residential", "receiverName": "Rodrigo Cunha", "addressId": "-1425945657910", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "postalCode": "22250-040", "city": "Rio de Janeiro", "state": "RJ", "country": "BRA", "street": "Praia de Botafogo", "number": "300", "neighborhood": "Botafogo", "complement": "3", "reference": null, "geoCoordinates": [] } }, "LogisticsInfo": { "title": "LogisticsInfo", "required": [ "itemIndex", "selectedSla", "lockTTL", "price", "listPrice", "sellingPrice", "deliveryWindow", "deliveryCompany", "shippingEstimate", "shippingEstimateDate", "slas", "shipsTo", "deliveryIds", "deliveryChannels", "deliveryChannel", "pickupStoreInfo", "addressId", "versionId", "entityId", "polygonName", "pickupPointId", "transitTime" ], "type": "object", "properties": { "itemIndex": { "type": "integer", "description": "Index of the item starting from 0." }, "selectedSla": { "type": "string", "description": "Selected shipping option." }, "lockTTL": { "type": "string", "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time." }, "price": { "type": "integer", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price." }, "listPrice": { "type": "integer", "description": "SKU's optional price for a specific trade policy." }, "sellingPrice": { "type": "integer", "description": "Item's selling price." }, "deliveryWindow": { "type": "string", "nullable": true, "description": "[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item." }, "deliveryCompany": { "type": "string", "description": "[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name." }, "shippingEstimate": { "type": "string", "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`." }, "shippingEstimateDate": { "type": "string", "description": "Shipping estimate date. It is defined only after the confirmation of the order." }, "slas": { "type": "array", "items": { "$ref": "#/components/schemas/Sla" }, "description": "Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140)." }, "shipsTo": { "type": "array", "items": { "type": "string" }, "description": "Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3)." }, "deliveryIds": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryId" }, "description": "Information about delivery IDs." }, "deliveryChannels": { "type": "array", "description": "List of delivery channels associated with the trade policy.", "items": { "type": "object", "required": ["id", "stockBalance"], "properties": { "id": { "type": "string", "description": "Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`." }, "stockBalance": { "type": "integer", "description": "Stock check for an SKU availability." } } } }, "deliveryChannel": { "type": "string", "description": "If the delivery channel is `delivery` or `pickup-in-point`." }, "pickupStoreInfo": { "$ref": "#/components/schemas/PickupStoreInfo" }, "addressId": { "type": "string", "description": "Address ID." }, "versionId": { "type": "string", "description": "Shipping address version ID.", "nullable": true }, "entityId": { "type": "string", "description": "Shipping address entity ID." }, "polygonName": { "type": "string", "nullable": true, "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy." }, "pickupPointId": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID." }, "transitTime": { "type": "string", "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`." } }, "example": { "itemIndex": 0, "selectedSla": "Normal", "lockTTL": "10d", "price": 1160, "listPrice": 1160, "sellingPrice": 1160, "deliveryWindow": null, "deliveryCompany": "Todos os CEPS", "shippingEstimate": "5bd", "shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00", "slas": [ { "id": "Normal", "name": "Normal", "shippingEstimate": "5bd", "deliveryWindow": null, "price": 1160, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "region196", "lockTTL": "12d", "pickupPointId": "1_VTEX-RJ", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Expressa", "name": "Expressa", "shippingEstimate": "5bd", "deliveryWindow": null, "price": 1160, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "region196", "lockTTL": "12d", "pickupPointId": "1_VTEX-RJ", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Quebra Kit", "name": "Quebra Kit", "shippingEstimate": "2bd", "deliveryWindow": null, "price": 1392, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "region196", "lockTTL": "12d", "pickupPointId": "1_VTEX-RJ", "transitTime": "3d", "pickupDistance": 0.0 }, { "id": "Sob Encomenda", "name": "Sob Encomenda", "shippingEstimate": "32bd", "deliveryWindow": null, "price": 1392, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": "region196", "lockTTL": "12d", "pickupPointId": "1_VTEX-RJ", "transitTime": "3d", "pickupDistance": 0.0 } ], "shipsTo": ["BRA"], "deliveryIds": [ { "courierId": "197a56f", "courierName": "Todos os CEPS", "dockId": "1", "quantity": 1, "warehouseId": "1_1", "accountCarrierName": "recorrenciaqa", "kitItemDetails": [] } ], "deliveryChannels": [ { "id": "delivery", "stockBalance": 0 } ], "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "addressId": "-1425945657910", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "polygonName": null, "pickupPointId": "1_VTEX-RJ", "transitTime": "3d" } }, "Sla": { "title": "Sla", "required": [ "id", "name", "shippingEstimate", "deliveryWindow", "price", "deliveryChannel", "pickupStoreInfo", "polygonName", "lockTTL", "pickupPointId", "transitTime", "pickupDistance" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)." }, "name": { "type": "string", "description": "Name of the shipping policy." }, "shippingEstimate": { "type": "string", "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`." }, "deliveryWindow": { "type": "string", "nullable": true, "description": "[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item." }, "price": { "type": "integer", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price." }, "deliveryChannel": { "type": "string", "description": "If the delivery channel is `delivery` or `pickup-in-point`." }, "pickupStoreInfo": { "$ref": "#/components/schemas/PickupStoreInfo" }, "polygonName": { "type": "string", "nullable": true, "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy." }, "lockTTL": { "type": "string", "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA." }, "pickupPointId": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA." }, "transitTime": { "type": "string", "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`." }, "pickupDistance": { "type": "number", "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line." } }, "example": { "id": "Normal", "name": "Normal", "shippingEstimate": "5bd", "deliveryWindow": null, "price": 1160, "deliveryChannel": "delivery", "pickupStoreInfo": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false }, "polygonName": null, "lockTTL": "12d", "pickupPointId": "1_VTEX-RJ", "transitTime": "3d", "pickupDistance": 0.0 } }, "PickupStoreInfo": { "title": "PickupStoreInfo", "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "required": [ "additionalInfo", "address", "dockId", "friendlyName", "isPickupStore" ], "type": "object", "properties": { "additionalInfo": { "type": "string", "nullable": true, "description": "Additional information about the pickup point." }, "address": { "type": "string", "nullable": true, "description": "Pickup point's address." }, "dockId": { "type": "string", "nullable": true, "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point." }, "friendlyName": { "type": "string", "nullable": true, "description": "Name of the pickup point displayed at checkout." }, "isPickupStore": { "type": "boolean", "description": "If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not." } }, "example": { "additionalInfo": null, "address": null, "dockId": null, "friendlyName": null, "isPickupStore": false } }, "DeliveryId": { "title": "DeliveryId", "description": "Information about delivery IDs.", "required": [ "courierId", "courierName", "dockId", "quantity", "warehouseId", "accountCarrierName", "kitItemDetails" ], "type": "object", "properties": { "courierId": { "type": "string", "description": "[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID." }, "courierName": { "type": "string", "description": "Carrier's name." }, "dockId": { "type": "string", "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj)." }, "quantity": { "type": "integer", "description": "Quantity of items." }, "warehouseId": { "type": "string", "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)." }, "accountCarrierName": { "type": "string", "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)." }, "kitItemDetails": { "type": "array", "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.", "nullable": true, "items": { "type": "string" } } }, "example": { "courierId": "197a56f", "courierName": "Todos os CEPS", "dockId": "1", "quantity": 1, "warehouseId": "1_1", "accountCarrierName": "recorrenciaqa", "kitItemDetails": [] } }, "SelectedAddress": { "title": "SelectedAddress", "required": [ "addressId", "versionId", "entityId", "addressType", "receiverName", "street", "number", "complement", "neighborhood", "postalCode", "city", "state", "country", "reference", "geoCoordinates" ], "type": "object", "properties": { "addressId": { "type": "string", "description": "Selected address ID." }, "versionId": { "type": "string", "description": "Shipping address version ID of the selected address.", "nullable": true }, "entityId": { "type": "string", "description": "Shipping address entity ID of the selected address.", "nullable": true }, "addressType": { "type": "string", "description": "Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`." }, "receiverName": { "type": "string", "description": "Name of the person who is going to receive the order in the selected address." }, "street": { "type": "string", "description": "Street of the selected address." }, "number": { "type": "string", "description": "Number of the building, house or apartment of the selected address." }, "complement": { "type": "string", "description": "Complement to the selected address if it applies." }, "neighborhood": { "type": "string", "description": "Neighborhood of the selected address." }, "postalCode": { "type": "string", "description": "Postal code of the selected address." }, "city": { "type": "string", "description": "City of the selected address." }, "state": { "type": "string", "description": "State of the selected address." }, "country": { "type": "string", "description": "Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3)." }, "reference": { "type": "string", "nullable": true, "description": "Complement to help locate the selected address." }, "geoCoordinates": { "type": "array", "items": { "type": "number" }, "description": "Array with two numbers with the selected address's geocoordinates, first longitude then latitude." } }, "example": { "addressId": "-1425945657910", "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f", "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad", "addressType": "residential", "receiverName": "Rodrigo Cunha", "street": "Praia de Botafogo", "number": "518", "complement": "10", "neighborhood": "Botafogo", "postalCode": "22250-040", "city": "Rio de Janeiro", "state": "RJ", "country": "BRA", "reference": null, "geoCoordinates": [] } }, "PaymentData": { "title": "PaymentData", "description": "Object with information about the payment.", "required": ["transactions"], "type": "object", "properties": { "giftCards": { "type": "array", "description": "Array with information about Gift Cards.", "items": { "type": "string" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" }, "description": "Information about financial transactions." } }, "example": { "giftCards": [], "transactions": [ { "isActive": true, "transactionId": "418213DE29634837A63DD693A937A696", "merchantName": "luxstore", "payments": [ { "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3", "paymentSystem": "6", "paymentSystemName": "Boleto Bancário", "value": 4450, "installments": 1, "referenceValue": 4450, "cardHolder": null, "cardNumber": null, "firstDigits": null, "lastDigits": null, "cvv2": null, "expireMonth": null, "expireYear": null, "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}", "giftCardId": null, "giftCardName": null, "giftCardCaption": null, "redemptionCode": null, "group": "bankInvoice", "tid": null, "dueDate": "2019-02-02", "connectorResponses": { "Tid": "94857956", "ReturnCode": "200", "Message": "logMessage", "authId": "857956" }, "giftCardProvider": "presentCard", "giftCardAsDiscount": false, "koinUrl": "koinURL", "accountId": "5BC5C6B417FE432AB971B1D399F190C9", "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9", "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050", "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5", "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065", "bankIssuedInvoiceBarCodeType": "i25", "billingAddress": {} } ] } ] } }, "Transaction": { "title": "Transaction", "description": "Financial transaction details.", "required": [ "isActive", "transactionId", "merchantName", "payments" ], "type": "object", "properties": { "isActive": { "type": "boolean", "description": "When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive." }, "transactionId": { "type": "string", "description": "ID of the transaction." }, "merchantName": { "type": "string", "description": "Name of the merchant that will receive the payment." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" }, "description": "Detailed information about payment." } }, "example": { "isActive": true, "transactionId": "418213DE29634837A63DD693A937A696", "merchantName": "luxstore", "payments": [ { "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3", "paymentSystem": "6", "paymentSystemName": "Boleto Bancário", "value": 4450, "installments": 1, "referenceValue": 4450, "cardHolder": null, "cardNumber": null, "firstDigits": null, "lastDigits": null, "cvv2": null, "expireMonth": null, "expireYear": null, "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}", "giftCardId": null, "giftCardName": null, "giftCardCaption": null, "redemptionCode": null, "group": "bankInvoice", "tid": null, "dueDate": "2019-02-02", "connectorResponses": { "Tid": "94857956", "ReturnCode": "200", "Message": "logMessage", "authId": "857956" }, "giftCardProvider": "presentCard", "giftCardAsDiscount": false, "koinUrl": "koinURL", "accountId": "5BC5C6B417FE432AB971B1D399F190C9", "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9", "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050", "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5", "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065", "bankIssuedInvoiceBarCodeType": "i25", "billingAddress": {} } ] } }, "Payment": { "title": "Payment", "description": "Payment details.", "required": [ "id", "paymentSystem", "paymentSystemName", "value", "installments", "referenceValue", "cardHolder", "cardNumber", "firstDigits", "lastDigits", "cvv2", "expireMonth", "expireYear", "url", "giftCardId", "giftCardName", "giftCardCaption", "redemptionCode", "group", "tid", "dueDate", "connectorResponses", "giftCardProvider", "giftCardAsDiscount", "koinUrl", "accountId", "parentAccountId", "bankIssuedInvoiceIdentificationNumber", "bankIssuedInvoiceIdentificationNumberFormatted", "bankIssuedInvoiceBarCodeNumber", "bankIssuedInvoiceBarCodeType", "billingAddress" ], "type": "object", "properties": { "id": { "type": "string", "description": "VTEX payment ID that can be used as unique identifier." }, "paymentSystem": { "type": "string", "description": "Payment system's ID." }, "paymentSystemName": { "type": "string", "description": "Payment system's name." }, "value": { "type": "integer", "description": "Payment's final amount in cents." }, "installments": { "type": "integer", "description": "Number of payment installments." }, "referenceValue": { "type": "integer", "description": "Payment's reference value in cents." }, "cardHolder": { "type": "string", "nullable": true, "description": "Name of the person who owns the card." }, "cardNumber": { "type": "string", "nullable": true, "description": "Numeric sequence of the card used in the transaction." }, "firstDigits": { "type": "string", "nullable": true, "description": "Fist digits of the card used in the transaction." }, "lastDigits": { "type": "string", "nullable": true, "description": "Last digits of the card used in the transaction." }, "cvv2": { "type": "string", "nullable": true, "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions." }, "expireMonth": { "type": "string", "nullable": true, "description": "Expire month of the card used in the transaction (2-digits)." }, "expireYear": { "type": "string", "nullable": true, "description": "Expire year of the card used in the transaction (4-digits)." }, "url": { "type": "string", "description": "Payment's URL." }, "giftCardId": { "type": "string", "nullable": true, "description": "Gift Card's ID." }, "giftCardName": { "type": "string", "nullable": true, "description": "Gift Card's name." }, "giftCardCaption": { "type": "string", "nullable": true, "description": "Gift Card's caption." }, "redemptionCode": { "type": "string", "nullable": true, "description": "Code for the customer to use the Gift Card." }, "group": { "type": "string", "description": "Name of the collection the Gift Card belongs to." }, "tid": { "type": "string", "nullable": true, "description": "Provider's unique identifier for the transaction." }, "dueDate": { "type": "string", "description": "Payment due date, with the format `yyyy-mm-dd`." }, "connectorResponses": { "type": "object", "description": "Information about the connector responses.", "required": ["Tid", "ReturnCode", "Message", "authId"], "properties": { "Tid": { "type": "string", "description": "Provider's unique identifier for the transaction." }, "ReturnCode": { "type": "string", "description": "Provider's operation/error code to be logged." }, "Message": { "type": "string", "description": "Provider's operation/error message to be logged." }, "authId": { "type": "string", "description": "Connector's authorization ID." } } }, "giftCardProvider": { "type": "string", "description": "Gift Card provider's ID." }, "giftCardAsDiscount": { "type": "boolean", "description": "When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount." }, "koinUrl": { "type": "string", "description": "Payment's account ID." }, "accountId": { "type": "string", "description": "Payment's account ID." }, "parentAccountId": { "type": "string", "description": "This field retrieves the main account if the payment was made in a subaccount." }, "bankIssuedInvoiceIdentificationNumber": { "type": "string", "description": "Numeric sequence that identifies the bank issued invoice." }, "bankIssuedInvoiceIdentificationNumberFormatted": { "type": "string", "description": "Bank issued invoice ID formatted." }, "bankIssuedInvoiceBarCodeNumber": { "type": "string", "description": "Number of the bank issued invoice bar code." }, "bankIssuedInvoiceBarCodeType": { "type": "string", "description": "Type of the bank issued invoice bar code." }, "billingAddress": { "type": "object", "description": "Billing address information." } }, "example": { "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3", "paymentSystem": "6", "paymentSystemName": "Boleto Bancário", "value": 4450, "installments": 1, "referenceValue": 4450, "cardHolder": null, "cardNumber": null, "firstDigits": null, "lastDigits": null, "cvv2": null, "expireMonth": null, "expireYear": null, "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}", "giftCardId": null, "giftCardName": null, "giftCardCaption": null, "redemptionCode": null, "group": "bankInvoice", "tid": null, "dueDate": "2019-02-02", "connectorResponses": { "Tid": "94857956", "ReturnCode": "200", "Message": "logMessage", "authId": "857956" }, "giftCardProvider": "presentCard", "giftCardAsDiscount": false, "koinUrl": "koinURL", "accountId": "5BC5C6B417FE432AB971B1D399F190C9", "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9", "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050", "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5", "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065", "bankIssuedInvoiceBarCodeType": "i25", "billingAddress": {} } }, "PackageAttachment": { "title": "PackageAttachment", "description": "Package object populated after order invoiced.", "required": ["packages"], "type": "object", "properties": { "packages": { "type": "array", "items": { "type": "string" }, "description": "Packages details." } }, "example": { "packages": [] } }, "Seller": { "title": "Seller", "description": "Information about the seller associated with the order.", "required": ["id", "name", "logo", "fulfillmentEndpoint"], "type": "object", "properties": { "id": { "type": "string", "description": "Seller ID that identifies the seller." }, "name": { "type": "string", "description": "Seller's name." }, "logo": { "type": "string", "description": "URL of the seller's logo." }, "fulfillmentEndpoint": { "type": "string", "description": "URL of the endpoint for fulfillment of seller's orders." } }, "example": { "id": "1", "name": "Loja do Suporte", "logo": "https://sellersLogo/images.png", "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName" } }, "ChangesAttachment": { "title": "ChangesAttachment", "description": "Information about changes in the order.", "required": ["id", "changesData"], "type": "object", "properties": { "id": { "type": "string", "description": "Object ID, the expect value is `changeAttachment`." }, "changesData": { "type": "array", "items": { "$ref": "#/components/schemas/ChangesDatum" }, "description": "Order change details." } }, "example": { "id": "changeAttachment", "changesData": [ { "reason": "Blah", "discountValue": 3290, "incrementValue": 0, "itemsAdded": [], "itemsRemoved": [ { "id": "1234568358", "name": "Bay Max L", "quantity": 1, "price": 3290, "unitMultiplier": null } ], "receipt": { "date": "2019-02-06T20:46:04.4003606+00:00", "orderId": "v5195004lux-01", "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b" } } ] } }, "ChangesDatum": { "title": "ChangesDatum", "required": [ "reason", "discountValue", "incrementValue", "itemsAdded", "itemsRemoved", "receipt" ], "type": "object", "properties": { "reason": { "type": "string", "description": "Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails." }, "discountValue": { "type": "integer", "description": "Order change discount value." }, "incrementValue": { "type": "integer", "description": "Order change increment value." }, "itemsAdded": { "type": "array", "items": { "type": "string" }, "description": "List of items added to the order." }, "itemsRemoved": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsRemoved" }, "description": "List of items removed from the order." }, "receipt": { "$ref": "#/components/schemas/Receipt" } }, "example": { "reason": "Blah", "discountValue": 3290, "incrementValue": 0, "itemsAdded": [], "itemsRemoved": [ { "id": "1234568358", "name": "Bay Max L", "quantity": 1, "price": 3290, "unitMultiplier": null } ], "receipt": { "date": "2019-02-06T20:46:04.4003606+00:00", "orderId": "v5195004lux-01", "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b" } } }, "ItemsRemoved": { "title": "ItemsRemoved", "required": [ "id", "name", "quantity", "price", "unitMultiplier" ], "type": "object", "properties": { "id": { "type": "string", "description": "SKU ID of the item removed from the order." }, "name": { "type": "string", "description": "Name of the item removed from the order." }, "quantity": { "type": "integer", "description": "Quantity of items removed from the order." }, "price": { "type": "integer", "description": "Total amount of items removed from the order." }, "unitMultiplier": { "type": "string", "nullable": true, "description": "Unit multiplier of the item removed from the order." } }, "example": { "id": "1234568358", "name": "Bay Max L", "quantity": 1, "price": 3290, "unitMultiplier": null } }, "Receipt": { "title": "Receipt", "description": "Information about the receipt for changed orders.", "required": ["date", "orderId", "receipt"], "type": "object", "properties": { "date": { "type": "string", "description": "Date when the receipt was created." }, "orderId": { "type": "string", "description": "ID of the order." }, "receipt": { "type": "string", "description": "Receipt's unique identifier code." } }, "example": { "date": "2019-02-06T20:46:04.4003606+00:00", "orderId": "v5195004lux-01", "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b" } }, "StorePreferencesData": { "title": "StorePreferencesData", "description": "Object with data from the store's configuration - stored in VTEX's License Manager.", "required": [ "countryCode", "currencyCode", "currencyFormatInfo", "currencyLocale", "currencySymbol", "timeZone" ], "type": "object", "properties": { "countryCode": { "type": "string", "description": "Three letters ISO code of the country (ISO 3166 ALPHA-3)." }, "currencyCode": { "type": "string", "description": "Currency code in ISO 4217. For example, `BRL`." }, "currencyFormatInfo": { "$ref": "#/components/schemas/CurrencyFormatInfo" }, "currencyLocale": { "type": "integer", "description": "Currency Locale Code in LCID in decimal." }, "currencySymbol": { "type": "string", "description": "Currency symbol." }, "timeZone": { "type": "string", "description": "Time zone from where the order was made." } }, "example": { "countryCode": "BRA", "currencyCode": "BRL", "currencyFormatInfo": { "CurrencyDecimalDigits": 2, "CurrencyDecimalSeparator": ",", "CurrencyGroupSeparator": ".", "CurrencyGroupSize": 3, "StartsWithCurrencySymbol": true }, "currencyLocale": 1046, "currencySymbol": "R$", "timeZone": "E. South America Standard Time" } }, "CurrencyFormatInfo": { "title": "CurrencyFormatInfo", "description": "Object with currency format details.", "required": [ "CurrencyDecimalDigits", "CurrencyDecimalSeparator", "CurrencyGroupSeparator", "CurrencyGroupSize", "StartsWithCurrencySymbol" ], "type": "object", "properties": { "CurrencyDecimalDigits": { "type": "integer", "description": "Quantity of currency decimal digits." }, "CurrencyDecimalSeparator": { "type": "string", "description": "Defines what currency decimal separator will be applied." }, "CurrencyGroupSeparator": { "type": "string", "description": "Defines what currency group separator will be applied." }, "CurrencyGroupSize": { "type": "integer", "description": "Defines how many characters will be grouped." }, "StartsWithCurrencySymbol": { "type": "boolean", "description": "Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`)." } }, "example": { "CurrencyDecimalDigits": 2, "CurrencyDecimalSeparator": ",", "CurrencyGroupSeparator": ".", "CurrencyGroupSize": 3, "StartsWithCurrencySymbol": true } }, "Marketplace": { "title": "Marketplace", "description": "Details about the marketplace related to the order.", "required": ["baseURL", "isCertified", "name"], "type": "object", "properties": { "baseURL": { "type": "string", "description": "Marketplace base URL." }, "isCertified": { "type": "string", "nullable": true, "description": "If is a certified marketplace." }, "name": { "type": "string", "description": "Name of the marketplace." } }, "example": { "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore", "isCertified": null, "name": "luxstore" } }, "ListOrders": { "title": "ListOrders", "required": ["list", "facets", "paging", "stats"], "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/List" }, "description": "Array containing list information." }, "facets": { "type": "array", "items": { "type": "string" }, "description": "Array containing facets information." }, "paging": { "$ref": "#/components/schemas/Paging" }, "stats": { "$ref": "#/components/schemas/Stats" } }, "example": { "list": [ { "orderId": "v502559llux-01", "creationDate": "2019-02-04T10:29:11+00:00", "clientName": "J C", "items": null, "totalValue": 7453, "paymentNames": "Boleto Bancário", "status": "invoiced", "statusDescription": "Faturado", "marketPlaceOrderId": null, "sequence": "502559", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-02-07T21:29:54+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502556llux-01", "creationDate": "2019-01-28T20:09:43+00:00", "clientName": "Rodrigo VTEX", "items": null, "totalValue": 1160, "paymentNames": "Boleto Bancário", "status": "handling", "statusDescription": "Preparando Entrega", "marketPlaceOrderId": null, "sequence": "502556", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ", "ShippingEstimatedDate": "2019-02-04T20:33:46+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-01-28T20:33:04+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502553llux-01", "creationDate": "2019-01-24T12:35:19+00:00", "clientName": "test test", "items": null, "totalValue": 10150, "paymentNames": "Mastercard", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": null, "sequence": "502554", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide", "ShippingEstimatedDate": "2019-01-31T12:36:30+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-01-24T12:36:01+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502550llux-01", "creationDate": "2019-01-23T16:39:45+00:00", "clientName": "test test", "items": null, "totalValue": 10150, "paymentNames": "Mastercard", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": null, "sequence": "502551", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", "ShippingEstimatedDate": "2019-01-30T16:40:55+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-01-23T16:40:27+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502547llux-01", "creationDate": "2019-01-23T16:34:20+00:00", "clientName": "test test", "items": null, "totalValue": 10150, "paymentNames": "Mastercard", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": null, "sequence": "502548", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", "ShippingEstimatedDate": "2019-01-30T16:35:30+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-01-23T16:35:04+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502544llux-01", "creationDate": "2018-12-28T18:15:28+00:00", "clientName": "test test", "items": null, "totalValue": 8990, "paymentNames": "Boleto Bancário", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": null, "sequence": "502544", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": null, "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502541llux-01", "creationDate": "2018-12-18T18:48:17+00:00", "clientName": "Douglas Rodrigues", "items": null, "totalValue": 3290, "paymentNames": "Boleto Bancário", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": null, "sequence": "502541", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": null, "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "v502538llux-01", "creationDate": "2018-12-12T18:21:47+00:00", "clientName": "test test", "items": null, "totalValue": 8990, "paymentNames": "Mastercard", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": null, "sequence": "502538", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", "ShippingEstimatedDate": "2018-12-19T18:22:26+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-12-12T18:22:22+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-880102018018-01", "creationDate": "2018-11-30T17:34:01+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": "880102018018-01", "sequence": "502537", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": "cancelamento teste shp ", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-30T17:34:42+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-880091692043-01", "creationDate": "2018-11-30T17:28:35+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "invoiced", "statusDescription": "Faturado", "marketPlaceOrderId": "880091692043-01", "sequence": "502536", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": null, "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-30T17:29:22+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-880091058221-01", "creationDate": "2018-11-30T17:18:00+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": "880091058221-01", "sequence": "502535", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": "Teste de cancelamento do ShopFácil ", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-30T17:18:44+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-880090643370-01", "creationDate": "2018-11-30T17:10:59+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": "880090643370-01", "sequence": "502534", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": null, "ShippingEstimatedDate": "2018-12-07T17:11:39+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-30T17:11:42+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-880090622238-01", "creationDate": "2018-11-30T17:10:45+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": "880090622238-01", "sequence": "502533", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": null, "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": null, "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "MNC-877730530419-01", "creationDate": "2018-11-20T21:09:01+00:00", "clientName": "Carlos VTEX", "items": null, "totalValue": 11150, "paymentNames": "", "status": "canceled", "statusDescription": "Cancelado", "marketPlaceOrderId": "877730530419-01", "sequence": "502532", "salesChannel": "1", "affiliateId": "MNC", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": null, "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-20T21:13:06+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" }, { "orderId": "SCP-876733475998-01", "creationDate": "2018-11-16T16:58:18+00:00", "clientName": "roberta grecco", "items": null, "totalValue": 1250, "paymentNames": "", "status": "ready-for-handling", "statusDescription": "Pronto para o manuseio", "marketPlaceOrderId": "876733475998-01", "sequence": "502531", "salesChannel": "1", "affiliateId": "SCP", "origin": "Fulfillment", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": null, "ShippingEstimatedDate": "2018-11-23T16:58:48+00:00", "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2018-11-16T16:58:53+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" } ], "facets": [], "paging": { "total": 84, "pages": 6, "currentPage": 1, "perPage": 15 }, "stats": { "stats": { "totalValue": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } } }, "totalItems": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } } } } } } }, "List": { "title": "List", "required": [ "orderId", "creationDate", "clientName", "items", "totalValue", "paymentNames", "status", "statusDescription", "marketPlaceOrderId", "sequence", "salesChannel", "affiliateId", "origin", "workflowInErrorState", "workflowInRetry", "lastMessageUnread", "ShippingEstimatedDate", "ShippingEstimatedDateMax", "ShippingEstimatedDateMin", "orderIsComplete", "listId", "listType", "authorizedDate", "callCenterOperatorName", "totalItems", "currencyCode" ], "type": "object", "properties": { "orderId": { "type": "string" }, "creationDate": { "type": "string" }, "clientName": { "type": "string" }, "items": { "type": "string", "nullable": true }, "totalValue": { "type": "integer" }, "paymentNames": { "type": "string" }, "status": { "type": "string" }, "statusDescription": { "type": "string", "description": "`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value." }, "marketPlaceOrderId": { "type": "string", "nullable": true }, "sequence": { "type": "string" }, "salesChannel": { "type": "string" }, "affiliateId": { "type": "string" }, "origin": { "type": "string" }, "workflowInErrorState": { "type": "boolean" }, "workflowInRetry": { "type": "boolean" }, "lastMessageUnread": { "type": "string", "nullable": true }, "ShippingEstimatedDate": { "type": "string", "nullable": true }, "ShippingEstimatedDateMax": { "type": "string", "nullable": true }, "ShippingEstimatedDateMin": { "type": "string", "nullable": true }, "orderIsComplete": { "type": "boolean" }, "listId": { "type": "string", "nullable": true }, "listType": { "type": "string", "nullable": true }, "authorizedDate": { "type": "string", "nullable": true }, "callCenterOperatorName": { "type": "string", "nullable": true }, "totalItems": { "type": "integer" }, "currencyCode": { "type": "string" } }, "example": { "orderId": "v502559llux-01", "creationDate": "2019-02-04T10:29:11+00:00", "clientName": "J C", "items": null, "totalValue": 7453, "paymentNames": "Boleto Bancário", "status": "invoiced", "statusDescription": "Faturado", "marketPlaceOrderId": null, "sequence": "502559", "salesChannel": "1", "affiliateId": "", "origin": "Marketplace", "workflowInErrorState": false, "workflowInRetry": false, "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci", "ShippingEstimatedDate": null, "ShippingEstimatedDateMax": null, "ShippingEstimatedDateMin": null, "orderIsComplete": true, "listId": null, "listType": null, "authorizedDate": "2019-02-07T21:29:54+00:00", "callCenterOperatorName": null, "totalItems": 1, "currencyCode": "BRL" } }, "Paging": { "type": "object", "description": "Pagination information.", "required": [ "total", "pages", "currentPage", "perPage" ], "properties": { "total": { "type": "integer", "description": "Total number of orders." }, "pages": { "type": "integer", "description": "Total number of pages." }, "currentPage": { "type": "integer", "description": "Number of the current page." }, "perPage": { "type": "integer", "description": "Number of orders per page." } } }, "Stats": { "title": "Stats", "required": ["stats"], "type": "object", "properties": { "stats": { "$ref": "#/components/schemas/Stats1" } }, "example": { "stats": { "totalValue": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } } }, "totalItems": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } } } } } }, "Stats1": { "title": "Stats1", "required": ["totalValue", "totalItems"], "type": "object", "properties": { "totalValue": { "$ref": "#/components/schemas/TotalValue" }, "totalItems": { "$ref": "#/components/schemas/TotalItems" } }, "example": { "totalValue": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } } }, "totalItems": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } } } } }, "TotalValue": { "title": "TotalValue", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "$ref": "#/components/schemas/Facets" } }, "example": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } } } }, "Facets": { "title": "Facets", "required": ["origin", "currencyCode"], "type": "object", "properties": { "origin": { "$ref": "#/components/schemas/Origin" }, "currencyCode": { "$ref": "#/components/schemas/CurrencyCode" } }, "example": { "origin": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } } }, "Origin": { "title": "Origin", "required": ["Fulfillment", "Marketplace"], "type": "object", "properties": { "Fulfillment": { "$ref": "#/components/schemas/Fulfillment" }, "Marketplace": { "$ref": "#/components/schemas/Marketplace1" } }, "example": { "Fulfillment": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null }, "Marketplace": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } } }, "Fulfillment": { "title": "Fulfillment", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 68, "Max": 11150, "Mean": 1395.5882352941176, "Min": 1250, "Missing": 0, "StdDev": 1200.5513439298484, "Sum": 94900, "SumOfSquares": 229010000, "Facets": null } }, "Marketplace1": { "title": "Marketplace1", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 16, "Max": 21526180, "Mean": 1373100.6875, "Min": 1160, "Missing": 0, "StdDev": 5374326.141087491, "Sum": 21969611, "SumOfSquares": 463417210029853, "Facets": null } }, "CurrencyCode": { "title": "CurrencyCode", "required": ["BRL"], "type": "object", "properties": { "BRL": { "$ref": "#/components/schemas/BRL" } }, "example": { "BRL": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } } }, "BRL": { "title": "BRL", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 84, "Max": 21526180, "Mean": 262672.75, "Min": 1160, "Missing": 0, "StdDev": 2348087.3869179883, "Sum": 22064511, "SumOfSquares": 463417439039853, "Facets": null } }, "TotalItems": { "title": "TotalItems", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "$ref": "#/components/schemas/Facets1" } }, "example": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": { "origin": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } } } }, "Facets1": { "title": "Facets1", "required": ["origin", "currencyCode"], "type": "object", "properties": { "origin": { "$ref": "#/components/schemas/Origin1" }, "currencyCode": { "$ref": "#/components/schemas/CurrencyCode1" } }, "example": { "origin": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "currencyCode": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } } }, "Origin1": { "title": "Origin1", "required": ["Fulfillment", "Marketplace"], "type": "object", "properties": { "Fulfillment": { "$ref": "#/components/schemas/Fulfillment1" }, "Marketplace": { "$ref": "#/components/schemas/Marketplace2" } }, "example": { "Fulfillment": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null }, "Marketplace": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } } }, "Fulfillment1": { "title": "Fulfillment1", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "integer" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "integer" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 68, "Max": 1, "Mean": 1, "Min": 1, "Missing": 0, "StdDev": 0, "Sum": 68, "SumOfSquares": 68, "Facets": null } }, "Marketplace2": { "title": "Marketplace2", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 16, "Max": 89, "Mean": 7.4375, "Min": 1, "Missing": 0, "StdDev": 21.92401651157926, "Sum": 119, "SumOfSquares": 8095, "Facets": null } }, "CurrencyCode1": { "title": "CurrencyCode1", "required": ["BRL"], "type": "object", "properties": { "BRL": { "$ref": "#/components/schemas/BRL1" } }, "example": { "BRL": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } } }, "BRL1": { "title": "BRL1", "required": [ "Count", "Max", "Mean", "Min", "Missing", "StdDev", "Sum", "SumOfSquares", "Facets" ], "type": "object", "properties": { "Count": { "type": "integer" }, "Max": { "type": "integer" }, "Mean": { "type": "number" }, "Min": { "type": "integer" }, "Missing": { "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { "type": "integer" }, "SumOfSquares": { "type": "integer" }, "Facets": { "type": "string", "nullable": true } }, "example": { "Count": 84, "Max": 89, "Mean": 2.2261904761904763, "Min": 1, "Missing": 0, "StdDev": 9.660940100525016, "Sum": 187, "SumOfSquares": 8163, "Facets": null } }, "Updatepartialinvoice.SendTrackingNumber.Request": { "title": "Updatepartialinvoice.SendTrackingNumber.Request", "required": [ "trackingNumber", "trackingUrl", "courier", "dispatchedDate" ], "type": "object", "properties": { "trackingNumber": { "type": "string", "description": "The number code that identifies the order tracking." }, "trackingUrl": { "type": "string", "nullable": true, "description": "Package tracking URL." }, "dispatchedDate": { "type": "string", "nullable": true, "description": "Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00." }, "courier": { "type": "string", "nullable": true, "description": "The name of the carrier responsible for delivering the order." } }, "example": { "trackingNumber": "87658", "trackingUrl": "https://www.tracking.com/url", "courier": "carrierOne", "dispatchedDate": "2022-02-08T13:16:13.4617653+00:00" } }, "Updatepartialinvoice.SendTrackingNumber": { "title": "Updatepartialinvoice.SendTrackingNumber", "required": ["date", "orderId", "receipt"], "type": "object", "properties": { "date": { "type": "string" }, "orderId": { "type": "string" }, "receipt": { "type": "string" } }, "example": { "date": "2019-02-08T13:16:13.4617653+00:00", "orderId": "00-v5195004lux-01", "receipt": "527b1ae251264ef1b7a9b597cd8f16b9" } }, "UpdateTrackingStatusRequest": { "title": "UpdateTrackingStatusRequest", "required": ["isDelivered", "deliveredDate", "events"], "type": "object", "properties": { "isDelivered": { "type": "boolean", "description": "When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address.", "example": false }, "deliveredDate": { "type": "string", "nullable": true, "description": "Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The `deliveredDate` format is `yyyy-mm-dd hh:mm`.", "example": "2022-10-01 21:15" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" }, "description": "Array containing events information." } }, "example": { "isDelivered": false, "deliveredDate": null, "events": [ { "city": "Rio de Janeiro", "state": "RJ", "description": "Coletado pela transportadora", "date": "2015-06-23" }, { "city": "Sao Paulo", "state": "SP", "description": "A caminho de Curitiba", "date": "2015-06-24" } ] } }, "Event": { "title": "Event", "required": ["city", "state", "description", "date"], "type": "object", "properties": { "city": { "type": "string" }, "state": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string" } }, "example": { "city": "Rio de Janeiro", "state": "RJ", "description": "Coletado pela transportadora", "date": "2015-06-23" } }, "UpdateTrackingStatus": { "title": "UpdateTrackingStatus", "required": ["date", "orderId", "receipt"], "type": "object", "properties": { "date": { "type": "string" }, "orderId": { "type": "string" }, "receipt": { "type": "string" } }, "example": { "date": "2017-03-29T18:04:31.0521233+00:00", "orderId": "v501245lspt-01", "receipt": "f67d33a8029c42ce9a8f07fc17f54449" } }, "GetConversation": { "title": "GetConversation", "required": [ "id", "from", "to", "subject", "firstWords", "body", "hasAttachment", "attachmentNames", "date" ], "type": "object", "properties": { "id": { "type": "string", "description": "Conversation ID.", "example": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3" }, "from": { "$ref": "#/components/schemas/From" }, "to": { "type": "array", "items": { "$ref": "#/components/schemas/To" }, "description": "Conversation receiver." }, "subject": { "type": "string", "description": "Conversation content subject.", "example": "Your payment has been aproved." }, "firstWords": { "type": "string", "description": "First words of Conversation content.", "example": "Your payment has been aproved and we are waiting for..." }, "body": { "type": "string", "description": "Conversation content body.", "example": "
|
|